Skip to content

Commit 3b19b98

Browse files
Koichi98Koichi98
authored
introduce vfs (#528)
Signed-off-by: Koichi <[email protected]>
1 parent a3087e6 commit 3b19b98

File tree

22 files changed

+8913
-0
lines changed

22 files changed

+8913
-0
lines changed

‎awkernel_lib/src/file/vfs/LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2020 Manuel Woelker
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎awkernel_lib/src/file/vfs/README.md‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
# rust-vfs
2+
3+
[![Crate](https://img.shields.io/crates/v/vfs.svg)](https://crates.io/crates/vfs)
4+
[![API](https://docs.rs/vfs/badge.svg)](https://docs.rs/vfs)
5+
![Minimum rustc version](https://img.shields.io/badge/rustc-1.63.0+-green.svg)
6+
[![Actions Status](https://github.com/manuel-woelker/rust-vfs/workflows/Continuous%20integration/badge.svg)](https://github.com/manuel-woelker/rust-vfs/actions?query=workflow%3A%22Continuous+integration%22)
7+
8+
A virtual filesystem for Rust
9+
10+
The virtual file system abstraction generalizes over file systems and allows using
11+
different filesystem implementations (e.g. an in memory implementation for unit tests)
12+
13+
This crate currently has the following implementations:
14+
* **PhysicalFS** - the actual filesystem of the underlying OS
15+
* **MemoryFS** - an ephemeral in-memory file system, intended mainly for unit tests
16+
* **AltrootFS** - a file system with its root in a particular directory of another filesystem
17+
* **OverlayFS** - an overlay file system combining two filesystems, an upper layer with read/write access and a lower layer with only read access
18+
* **EmbeddedFS** - a read-only file system embedded in the executable, requires `embedded-fs` feature, no async version available
19+
20+
The minimum supported Rust version (MSRV) is 1.63.
21+
22+
Comments and pull-requests welcome!
23+
24+
## Changelog
25+
26+
27+
### 0.12.1 (2025-03-24)
28+
* MemoryFS: The `flush()` method now makes the written data available to read calls (fixes [#70](https://github.com/manuel-woelker/rust-vfs/issues/70) - thanks [@krisajenkins](https://github.com/krisajenkins) for the throrough bug report!)
29+
30+
### 0.12.0 (2024-03-09)
31+
* Allow reading and setting modification/creation/access-times - thanks [@kartonrad](https://github.com/kartonrad)!
32+
* Allow seek when writing - thanks [@jonmclean](https://github.com/jonmclean)!
33+
34+
### 0.11.0 (2024-02-18)
35+
* Updated minimum supported Rust version to 1.63.
36+
* Updated rust-embed dependency to 8.0 - thanks [@NickAcPT](https://github.com/NickAcPT)!
37+
* Unlocked tokio crate version to work with newer versions - thanks [@Fredrik-Reinholdsen](https://github.com/Fredrik-Reinholdsen)!
38+
* use `Arc<str>` for paths internally to reduce string allocations - thanks [@BrettMayson](https://github.com/BrettMayson)!
39+
40+
### 0.10.0 (2023-09-08)
41+
* Added async port of the crate, in a new module `async_vfs`.
42+
The module is behind the `async-vfs` feature flag which is not enabled by default. Huge thank you to [@Fredrik Reinholdsen](https://github.com/Fredrik-Reinholdsen)!
43+
* Ported all synchronous tests and doc-tests to async
44+
* Updated minimum supported Rust version to 1.61.0, needed for the async port.
45+
* Updated Rust edition from *2018* to *2021*, needed for the async port.
46+
* Updated Rust versions used in CI pipeline.
47+
48+
### 0.9.0 (2022-12-20)
49+
50+
* prevent `Path::create_dir_all()` failures when executing in parallel
51+
(fixes [#47](https://github.com/manuel-woelker/rust-vfs/pull/47))
52+
* Allow absolute paths (e.g. starting with "/") in `VfsPath::join()`
53+
([#45](https://github.com/manuel-woelker/rust-vfs/pull/45) - thanks [@Property404](https://github.com/Property404))
54+
* Allow multiple consecutive slashes in paths
55+
([#43](https://github.com/manuel-woelker/rust-vfs/pull/43) - thanks [@Property404](https://github.com/Property404))
56+
* Add method `VfsPath::is_root()`
57+
([#44](https://github.com/manuel-woelker/rust-vfs/pull/44) - thanks [@Property404](https://github.com/Property404))
58+
* `Path::join()` now allows resolving '..' at the root (resolving to root itself)
59+
([#41](https://github.com/manuel-woelker/rust-vfs/pull/41) - thanks [@Property404](https://github.com/Property404))
60+
* Add `Send` to trait objects returned from APIs
61+
([#40](https://github.com/manuel-woelker/rust-vfs/pull/40),
62+
[#46](https://github.com/manuel-woelker/rust-vfs/pull/46) - thanks [@Property404](https://github.com/Property404))
63+
64+
### 0.8.0 (2022-11-24)
65+
66+
* Impl `std::error::Error` for `VfsError` ([#32](https://github.com/manuel-woelker/rust-vfs/pull/32)) and improved error
67+
ergonomics for end users ([#34](https://github.com/manuel-woelker/rust-vfs/pull/34)) - thanks [@Technohacker](https://github.com/Technohacker)
68+
69+
### 0.7.1 (2022-04-15)
70+
71+
* Fixed a panic when accessing non-existing paths in `MemoryFS::append_file()` (closes
72+
[#31](https://github.com/manuel-woelker/rust-vfs/issues/31))
73+
74+
### 0.7.0 (2022-03-26)
75+
76+
* Update to `EmbeddedFS` to `rust-embed` v6 (closes [#29](https://github.com/manuel-woelker/rust-vfs/issues/29))
77+
* Make `OverlayFS` and `AltrootFS` available at the crate root, making it more consistent
78+
(PR [#30](https://github.com/manuel-woelker/rust-vfs/issues/30) -
79+
thanks [@Zyian](https://github.com/Zyian))
80+
81+
### 0.6.2 (2022-03-07)
82+
83+
* Activate `embedded-fs` feature when building on docs.rs to ensure that it actually shows up there
84+
([#28](https://github.com/manuel-woelker/rust-vfs/issues/28) - thanks [@Absolucy](https://github.com/Absolucy))
85+
86+
### 0.6.1 (2022-03-06)
87+
88+
* Added `VfsPath::root()` method to access the root path of a virtual filesystem
89+
(closes [#26](https://github.com/manuel-woelker/rust-vfs/issues/26))
90+
* Added doctests to `VfsPath` docs to provide usage examples
91+
92+
### 0.6.0 (2022-03-02)
93+
94+
* Fixed path inconsistency issues in `EmbeddedFS` (closes [#24](https://github.com/manuel-woelker/rust-vfs/issues/24))
95+
* Added the test macro `test_vfs_readonly!` which allows verifying read-only filesystem implementations
96+
* Removed dependency on `thiserror` crate to improve compile times
97+
(closes [#25](https://github.com/manuel-woelker/rust-vfs/issues/25))
98+
99+
### 0.5.2 (2022-02-07)
100+
101+
* Removed potential panic in `OverlayFS` (closes [#23](https://github.com/manuel-woelker/rust-vfs/issues/23))
102+
* `VfsPath::join()` now takes AsRef<str> instead of &str to improve ergonomics with crates like camino
103+
104+
### 0.5.1 (2021-02-13)
105+
106+
* Exported `test_vfs` macro via the feature flag `export-test-macros` to allow downstream implementations to verify
107+
expected behaviour
108+
* The MSRV is now 1.40 due to requirements in upstream crates
109+
* The embedded implementation was broken by the 0.5.0 API changes, and is now fixed
110+
111+
### 0.5.0 (2021-02-13)
112+
113+
* Added `EmbeddedFS` for using filesystems embeded in the binary using
114+
[rust-embed](https://github.com/pyros2097/rust-embed)
115+
(PR [#12](https://github.com/manuel-woelker/rust-vfs/issues/12) - thanks [@ahouts](https://github.com/ahouts))
116+
* Changed `VfsPath::exists()` to return `VfsResult<bool>` instead of plain `bool` (closes [#17](https://github.com/manuel-woelker/rust-vfs/issues/17))
117+
118+
### 0.4.0 (2020-08-13)
119+
120+
* Added `OverlayFS` union filesystem
121+
* Added `VfsPath::read_to_string()` convenience method
122+
* Added `VfsPath::walk_dir()` method for recursive directory traversal
123+
* Added `VfsPath::{copy,move}_{file,dir}()` methods (closes [#9](https://github.com/manuel-woelker/rust-vfs/issues/9))
124+
* License is now Apache 2.0
125+
* Minimum supported Rust version (MSRV) is 1.32.0
126+
127+
### 0.3.0 (2020-08-04)
128+
129+
* Refactored to use a trait based design, simplifying usage and testing
130+
131+
### 0.2.1 (2020-02-06)
132+
133+
* Added `AltrootFS` (thanks [@icefoxen](https://github.com/icefoxen))
134+
135+
### 0.1.0 (2016-05-14)
136+
137+
* Initial release
138+
139+
## Roadmap
140+
141+
* Support for read-only filesystems
142+
* Support for re-mounting filesystems
143+
* Support for virtual filesystem access inside archives (e.g. zip)

0 commit comments

Comments
 (0)