Struct LocalFilesystem 

pub struct LocalFilesystem { /* private fields */ }

Files under one root directory.

Every path is normalised and then joined to the root, and the result is checked to still be inside it. Two independent guards, because the consequence of getting it wrong is reading or writing anywhere the process can reach.

Implementations

impl LocalFilesystem

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

Files under root.

pub fn with_url_prefix(self, prefix: impl Into<String>) -> LocalFilesystem

The URL prefix files under this root are reachable at.

Only meaningful if something — nginx, a CDN, a route you wrote — actually serves the directory. Without it url is None, because a link that 404s is worse than no link.

pub fn root(&self) -> &Path

The root directory.

Trait Implementations

impl Debug for LocalFilesystem

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

Formats the value using the given formatter.

impl Filesystem for LocalFilesystem

fn name(&self) -> &str

A label for diagnostics — "local", "s3", "memory".

fn get<'a>( &'a self, path: &'a str, ) -> Pin<Box<dyn Future<Output = Result<Option<Bytes>, Error>> + Send + 'a>>

Read a file. None if it is not there.

fn put<'a>( &'a self, path: &'a str, contents: Bytes, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

Write a file, creating any directories it needs and replacing what was there.

fn delete<'a>( &'a self, path: &'a str, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'a>>

Delete a file. true if it was there.

fn exists<'a>( &'a self, path: &'a str, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'a>>

Whether a file exists.

fn metadata<'a>( &'a self, path: &'a str, ) -> Pin<Box<dyn Future<Output = Result<Option<Metadata>, Error>> + Send + 'a>>

A file’s metadata, or None.

fn list<'a>( &'a self, prefix: &'a str, ) -> Pin<Box<dyn Future<Output = Result<Vec<Metadata>, Error>> + Send + 'a>>

Every file directly under prefix, not recursing.

fn rename<'a>( &'a self, from: &'a str, to: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

Move a file.

fn url(&self, path: &str) -> Option<String>

A URL a browser can fetch, if this driver has one.

fn copy<'a>( &'a self, from: &'a str, to: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

Copy a file.