Struct Filesystem

pub struct Filesystem { /* private fields */ }

The Filesystem struct is an implementation of the StorageBackend trait that keeps its files inside a specific root directory on local disk.

Implementations

impl Filesystem

pub fn new<P: Into<PathBuf>>(root: P) -> Result<Self>

Create a new Filesystem backend, with the given root. No operations can take place outside of the root. For example, when the Filesystem root is set to /srv/ftp, and a client asks for hello.txt, the server will send it /srv/ftp/hello.txt.

Trait Implementations

impl Debug for Filesystem

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

Formats the value using the given formatter.

impl<User: UserDetail> StorageBackend<User> for Filesystem

type Metadata = Meta

The concrete type of the metadata used by this storage backend.

fn enter(&mut self, user_detail: &User) -> Result<()>

Restrict the backend’s capabilities commensurate with the provided UserDetail.

fn supported_features(&self) -> u32

Tells which optional features are supported by the storage back-end Return a value with bits set according to the FEATURE_* constants.

fn metadata<'life0, 'life1, 'async_trait, P>( &'life0 self, _user: &'life1 User, path: P, ) -> Pin<Box<dyn Future<Output = Result<Self::Metadata>> + Send + 'async_trait>>

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

Returns the Metadata for the given file.

fn list<'life0, 'life1, 'async_trait, P>( &'life0 self, _user: &'life1 User, path: P, ) -> Pin<Box<dyn Future<Output = Result<Vec<Fileinfo<PathBuf, Self::Metadata>>>> + Send + 'async_trait>>

where P: AsRef<Path> + Send + Debug + 'async_trait, <Self as StorageBackend<User>>::Metadata: Metadata, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns the list of files in the given directory.

fn get<'life0, 'life1, 'async_trait, P>( &'life0 self, _user: &'life1 User, path: P, start_pos: u64, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn AsyncRead + Send + Sync + Unpin>>> + Send + 'async_trait>>

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

Returns the content of the given file from offset start_pos. The starting position will only be greater than zero if the storage back-end implementation advertises to support partial reads through the supported_features method i.e. the result from supported_features yield 1 if a logical and operation is applied with FEATURE_RESTART.

fn put<'life0, 'life1, 'async_trait, P, R>( &'life0 self, _user: &'life1 User, bytes: R, path: P, start_pos: u64, ) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>

where P: 'async_trait + AsRef<Path> + Send, R: 'async_trait + AsyncRead + Send + Sync + 'static + Unpin, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Writes bytes from the given reader to the specified path starting at offset start_pos in the file

fn del<'life0, 'life1, 'async_trait, P>( &'life0 self, _user: &'life1 User, path: P, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Deletes the file at the given path.

fn rmd<'life0, 'life1, 'async_trait, P>( &'life0 self, _user: &'life1 User, path: P, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Deletes the given directory.

fn mkd<'life0, 'life1, 'async_trait, P>( &'life0 self, _user: &'life1 User, path: P, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Creates the given directory.

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

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

Renames the given file to the given new filename.

fn cwd<'life0, 'life1, 'async_trait, P>( &'life0 self, user: &'life1 User, path: P, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Changes the working directory to the given path.

fn name(&self) -> &str

Implement to set the name of the storage back-end. By default it returns the type signature.

fn md5<'life0, 'life1, 'async_trait, P>( &'life0 self, user: &'life1 User, path: P, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>

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

Returns the MD5 hash for the given file.

fn list_fmt<'life0, 'life1, 'async_trait, P>( &'life0 self, user: &'life1 User, path: P, ) -> Pin<Box<dyn Future<Output = Result<Cursor<Vec<u8>>, Error>> + Send + 'async_trait>>

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

Returns some bytes that make up a directory listing that can immediately be sent to the client.

fn list_vec<'life0, 'life1, 'async_trait, P>( &'life0 self, user: &'life1 User, path: P, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, Error>> + Send + 'async_trait>>

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

Returns directory listing as a vec of strings used for multi line response in the control channel.

fn nlst<'life0, 'life1, 'async_trait, P>( &'life0 self, user: &'life1 User, path: P, ) -> Pin<Box<dyn Future<Output = Result<Cursor<Vec<u8>>, Error>> + Send + 'async_trait>>

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

Returns some bytes that make up a NLST directory listing (only the basename) that can immediately be sent to the client.

fn get_into<'a, 'life0, 'life1, 'async_trait, P, W>( &'life0 self, user: &'life1 User, path: P, start_pos: u64, output: &'a mut W, ) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>>

where 'a: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, W: AsyncWrite + Unpin + Sync + Send + 'async_trait + ?Sized, P: AsRef<Path> + Send + Debug + 'async_trait, Self: 'async_trait,

Gets the content of the given FTP file from offset start_pos file by copying it to the output writer. The starting position will only be greater than zero if the storage back-end implementation advertises to support partial reads through the supported_features method i.e. the result from supported_features yield 1 if a logical and operation is applied with FEATURE_RESTART.