Struct LocalFs 

pub struct LocalFs { /* private fields */ }

Local filesystem backend.

All operations are relative to root. For example, if root is /home/amy/project, then read("src/main.rs") reads /home/amy/project/src/main.rs.

Implementations

impl LocalFs

pub fn new(root: impl Into<PathBuf>) -> LocalFs

Create a new local filesystem rooted at the given path.

The path must exist and be a directory.

pub fn read_only(root: impl Into<PathBuf>) -> LocalFs

Create a read-only local filesystem.

pub fn set_read_only(&mut self, read_only: bool)

Set whether this filesystem is read-only.

pub fn root(&self) -> &Path

Get the root path.

Trait Implementations

impl Clone for LocalFs

fn clone(&self) -> LocalFs

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LocalFs

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Filesystem for LocalFs

fn canonicalize<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, allow_missing_final: bool, ) -> Pin<Box<dyn Future<Output = Result<PathBuf, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalFs: 'async_trait,

A single resolve_beneath call, containment-checked there, instead of the trait default’s one round trip per path component.

resolve_beneath’s Follow::Final alone does not distinguish a missing FINAL component from a missing INTERMEDIATE one — it resolves to the deepest existing ancestor and appends whatever is missing, however many components that is. This checks the resolved answer’s parent separately: when the answer itself is missing, an existing parent means only the final component was absent (honor allow_missing_final); a missing parent means something deeper was missing too, which is always an error.

fn path_access<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<PathAccess, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalFs: 'async_trait,

Answers from the OS, not from mode bits — the one backend that can, and so the one backend that does not use PathAccess::resolve.

Mode bits say whether some principal may write. A root-owned 0o644 file has the bit set for a kaish running as an ordinary user who cannot write a byte, and test -w would have said yes. Every other backend models modes we chose ourselves, where the bits are the whole truth.

from_effective_access still ANDs in the read-only wrapper, which the OS cannot see. On non-Unix this falls through to the trait default over synthesized_mode.

fn read<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalFs: 'async_trait,

Read the entire contents of a file.

fn read_range<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, range: Option<ReadRange>, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalFs: 'async_trait,

Read a (possibly partial) slice of a file.

fn write<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 Path, data: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, LocalFs: 'async_trait,

Write data to a file, creating it if it doesn’t exist.

fn append<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 Path, data: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, LocalFs: 'async_trait,

Append data to a file, creating it if it doesn’t exist.

fn set_mtime<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, mtime: SystemTime, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalFs: 'async_trait,

Set the modification time of an existing path.

fn list<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Vec<DirEntry>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalFs: 'async_trait,

List entries in a directory.

fn stat<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<DirEntry, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalFs: 'async_trait,

Get metadata for a file or directory, following symlinks.

fn lstat<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<DirEntry, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalFs: 'async_trait,

Get metadata for a path without following its final symlink.

fn read_link<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<PathBuf, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalFs: 'async_trait,

Read the target of a symbolic link without following it.

fn symlink<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, target: &'life1 Path, link: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, LocalFs: 'async_trait,

Create a symbolic link.

fn mkdir<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalFs: 'async_trait,

Create a directory (and parent directories if needed).

fn remove<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, LocalFs: 'async_trait,

Remove a file, empty directory, or symlink.

fn rename<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, LocalFs: 'async_trait,

Rename (move) a file, directory, or symlink.

fn read_only(&self) -> bool

Returns true if this filesystem is read-only.

fn real_path(&self, path: &Path) -> Option<PathBuf>

Get the real filesystem path for a VFS path.

fn resident_bytes(&self) -> Option<u64>

Memory-resident content bytes this filesystem is holding, if it tracks them.

fn exists<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Check if a path exists, following symlinks.