Struct LocalDirectory

pub struct LocalDirectory { /* private fields */ }

A convenience wrapper over a local directory.

Implementations

impl LocalDirectory

pub fn new() -> Self

Returns a new local directory wrapper with no base path component. All operations will be on paths relative to the environment used by std::fs.

pub fn for_path(path: &PathBuf) -> Self

Returns a new local directory such that the methods on Self will operate as expected on path:

- if `path` is absolute, returns a directory at "/"
- if `path` is relative, returns a directory at `cwd`

Trait Implementations

impl Debug for LocalDirectory

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

Formats the value using the given formatter.

impl Directory for LocalDirectory

fn open_dir_readonly<P: AsRef<Path> + Send>( &self, relative_path: P, ) -> Result<Self>

Attempts to open the directory at relative_path with read-only rights.

fn open_dir_readwrite<P: AsRef<Path> + Send>( &self, relative_path: P, ) -> Result<Self>

Attempts to open the directory at relative_path with read/write rights.

fn create_dir<P: AsRef<Path> + Send>( &self, relative_path: P, _readwrite: bool, ) -> Result<Self>

Attempts to create a directory at relative_path with read right (if readwrite is false) or read/write rights (if readwrite is true).

fn clone(&self) -> Result<Self>

Return a copy of self.

fn read_file<'life0, 'async_trait, P>( &'life0 self, relative_path: P, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>

where P: 'async_trait + AsRef<Path> + Send, Self: 'async_trait, 'life0: 'async_trait,

Returns the contents of the file at relative_path as a string.

fn read_file_bytes<'life0, 'async_trait, P>( &'life0 self, relative_path: P, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>>> + Send + 'async_trait>>

where P: 'async_trait + AsRef<Path> + Send, Self: 'async_trait, 'life0: 'async_trait,

Returns the contents of the file at relative_path as bytes.

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

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

Returns true if an entry called filename exists in this directory. filename must be a plain file name, not a relative path.

fn entry_type<'life0, 'life1, 'async_trait>( &'life0 self, filename: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<DirentKind>>> + Send + 'async_trait>>

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

Returns the type of entry specified by filename, or None if no entry by that name is found. filename must be a plan file name, not a relative path.

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

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

Deletes the file at relative_path.

fn write_file<'life0, 'life1, 'async_trait, P>( &'life0 self, relative_path: P, data: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where P: 'async_trait + AsRef<Path> + Send, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Writes data to a file at relative_path. Overwrites if the file already exists.

fn get_file_size<'life0, 'async_trait, P>( &'life0 self, relative_path: P, ) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>

where P: 'async_trait + AsRef<Path> + Send, Self: 'async_trait, 'life0: 'async_trait,

Returns the size of the file at relative_path in bytes.

fn entry_names<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>>> + Send + 'async_trait>>

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

Returns a list of directory entry names as strings.