Struct libunftp::storage::filesystem::Filesystem

pub struct Filesystem { /* fields omitted */ }

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) -> 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

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

Formats the value using the given formatter.

impl<U: Send + Sync + Debug> StorageBackend<U> for Filesystem

type Metadata = Metadata

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

pub 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.

pub fn metadata<'life0, 'life1, 'async_trait, P: AsRef<Path> + Send + Debug>(
    &'life0 self,
    _user: &'life1 Option<U>,
    path: P
) -> Pin<Box<dyn Future<Output = Result<Self::Metadata>> + Send + 'async_trait>> where
    P: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Returns the Metadata for the given file.

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

Returns the list of files in the given directory.

pub fn get<'life0, 'life1, 'async_trait, P: AsRef<Path> + Send + Debug>(
    &'life0 self,
    _user: &'life1 Option<U>,
    path: P,
    start_pos: u64
) -> Pin<Box<dyn Future<Output = Result<Box<dyn AsyncRead + Send + Sync + Unpin>>> + Send + 'async_trait>> where
    P: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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.

pub fn put<'life0, 'life1, 'async_trait, P: AsRef<Path> + Send, R: AsyncRead + Send + Sync + 'static + Unpin>(
    &'life0 self,
    _user: &'life1 Option<U>,
    bytes: R,
    path: P,
    start_pos: u64
) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>> where
    P: 'async_trait,
    R: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

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

pub fn del<'life0, 'life1, 'async_trait, P: AsRef<Path> + Send + Debug>(
    &'life0 self,
    _user: &'life1 Option<U>,
    path: P
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    P: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Deletes the file at the given path.

pub fn rmd<'life0, 'life1, 'async_trait, P: AsRef<Path> + Send + Debug>(
    &'life0 self,
    _user: &'life1 Option<U>,
    path: P
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    P: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Deletes the given directory.

pub fn mkd<'life0, 'life1, 'async_trait, P: AsRef<Path> + Send + Debug>(
    &'life0 self,
    _user: &'life1 Option<U>,
    path: P
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    P: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Creates the given directory.

pub fn rename<'life0, 'life1, 'async_trait, P: AsRef<Path> + Send + Debug>(
    &'life0 self,
    _user: &'life1 Option<U>,
    from: P,
    to: P
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    P: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Renames the given file to the given new filename.

pub fn cwd<'life0, 'life1, 'async_trait, P: AsRef<Path> + Send + Debug>(
    &'life0 self,
    _user: &'life1 Option<U>,
    path: P
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    P: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Changes the working directory to the given path.

#[must_use]pub fn list_fmt<'life0, 'life1, 'async_trait, P>(
    &'life0 self,
    user: &'life1 Option<U>,
    path: P
) -> Pin<Box<dyn Future<Output = Result<Cursor<Vec<u8>>, Error>> + Send + 'async_trait>> where
    P: AsRef<Path> + Send + Debug,
    Self::Metadata: Metadata + 'static,
    P: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

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

#[must_use]pub fn nlst<'life0, 'life1, 'async_trait, P>(
    &'life0 self,
    user: &'life1 Option<U>,
    path: P
) -> Pin<Box<dyn Future<Output = Result<Cursor<Vec<u8>>, Error>> + Send + 'async_trait>> where
    P: AsRef<Path> + Send + Debug,
    Self::Metadata: Metadata + 'static,
    P: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

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

#[must_use]pub fn get_into<'a, 'life0, 'life1, 'async_trait, P, W: ?Sized>(
    &'life0 self,
    user: &'life1 Option<U>,
    path: P,
    start_pos: u64,
    output: &'a mut W
) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>> where
    W: AsyncWrite + Unpin + Sync + Send,
    P: AsRef<Path> + Send + Debug,
    'a: 'async_trait,
    P: 'async_trait,
    W: 'async_trait,
    'life0: 'async_trait,
    'life1: '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.