4 releases

new 0.2.4 Dec 5, 2024
0.2.2 Jan 21, 2024
0.2.1 Jan 20, 2024
0.2.0 Nov 27, 2023
0.1.0 Nov 27, 2023

#389 in Filesystem

Download history 65/week @ 2024-08-19 40/week @ 2024-08-26 17/week @ 2024-09-02 11/week @ 2024-09-09 15/week @ 2024-09-16 24/week @ 2024-09-23 52/week @ 2024-09-30 6/week @ 2024-10-07 37/week @ 2024-10-14 85/week @ 2024-10-21 99/week @ 2024-10-28 61/week @ 2024-11-04 54/week @ 2024-11-11 11/week @ 2024-11-18 123/week @ 2024-11-25 292/week @ 2024-12-02

480 downloads per month
Used in 7 crates (via sos-sdk)

MIT/Apache

80KB
2K SLoC

Virtual file system.

The API is designed to match the tokio::fs module which in turn is based on std::fs so the API should be familiar.

The default operating system VFS re-exports the tokio::fs module providing access to the operating system's file system.

Using the memory VFS allows us to compile and target the wasm32-unknown-unknown platform with minimal changes to the code.

The memory file system is enabled by default for wasm32-unknown-unknown or if the mem-fs feature is enabled.

Memory VFS Caveats

Relative paths are resolved from the root of the file system.

Avoid using the PathBuf functions exists(), metadata(), is_dir(), is_file() etc as they will be incorrect when using a virtual file system. Instead use the vfs::metadata() and vfs::try_exists() asynchronous functions.

The SystemTime type is not available on wasm32-unknown-unknwown so Metadata does not support created(), accessed() and modified() for that target.

Memory VFS Unsupported

This functionality is not supported yet but we hope to implement in the future.

The readonly flag on permissions is not supported yet.

Created, accessed and modified times are not set yet for non-webassembly targets that support SystemTime.

Symbolic links are not supported yet which means the hard_link(), symlink(), symlink_metadata(), symlink_file() and symlink_dir() functions are not available.

Dependencies

~1.4–8MB
~69K SLoC