Struct remi_fs::StorageService

pub struct StorageService { /* private fields */ }

Represents an implementation of a StorageService for the local filesystem.

Implementations

impl StorageService

pub fn new<P: AsRef<Path>>(path: P) -> StorageService

Creates a new StorageService instance.

pub fn with_config(config: Config) -> StorageService

Creates a new StorageService instance with a provided configuration object.

pub fn with_resolver<R: ContentTypeResolver + 'static>( self, resolver: R ) -> StorageService

Updates the given ContentTypeResolver to something else.

pub fn normalize<P: AsRef<Path>>(&self, path: P) -> Result<Option<PathBuf>>

Attempts to normalize a given path and returns a canonical, absolute path. It must follow some strict rules:

• If the path starts with ./, then it will resolve from Config::directory if the directory was found. Otherwise, it’ll use the current directory.

• If the path starts with ~/, then it will resolve from the home directory from dirs::home_dir.

Trait Implementations

impl Clone for StorageService

fn clone(&self) -> StorageService

Returns a copy of the value.

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

Performs copy-assignment from source.

impl StorageService for StorageService

type Error = Error

Represents a generic error to use for errors that could be emitted when calling any function.

const NAME: &'static str = "remi:fs"

The name of the storage service.

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

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

Optionally initialize this StorageService if it requires initialization, like creating a directory if it doesn’t exist.

fn open<'life0, 'async_trait, P>( &'life0 self, path: P ) -> Pin<Box<dyn Future<Output = Result<Option<Bytes>>> + Send + 'async_trait>>

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

Opens a file in the specified path and returns the contents as Bytes if it existed, otherwise None will be returned to indicate that file doesn’t exist.

fn blob<'life0, 'async_trait, P>( &'life0 self, path: P ) -> Pin<Box<dyn Future<Output = Result<Option<Blob>>> + Send + 'async_trait>>

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

Open a file in the given path and returns a Blob structure if the path existed, otherwise None will be returned to indiciate that a file doesn’t exist.

fn blobs<'life0, 'async_trait, P>( &'life0 self, path: Option<P>, options: Option<ListBlobsRequest> ) -> Pin<Box<dyn Future<Output = Result<Vec<Blob>>> + Send + 'async_trait>>

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

Iterate over a list of files from a storage service and returns a Vec of Blobs.

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

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

Deletes a file in a specified path. At the moment, () is returned but bool might be returned to indicate if it actually deleted itself or not.

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

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

Checks the existence of the file by the specified path.

fn upload<'life0, 'async_trait, P>( &'life0 self, path: P, options: UploadRequest ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Does a file upload where it writes the byte array as one call and does not do chunking. Use the [StorageService::multipart_upload] method to upload chunks by a specific size.

fn name(&self) -> &'static str

👎Deprecated since 0.5.0: use Self::NAME instead of the name() function, this will be removed in 0.7.0

Returns the name of this StorageService.

fn find<'life0, 'async_trait, P, F>( &'life0 self, path: Option<P>, options: Option<ListBlobsRequest>, finder: F ) -> Pin<Box<dyn Future<Output = Result<Option<Blob>, Self::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, P: 'async_trait + AsRef<Path> + Send, F: 'async_trait + FnMut(&Blob) -> bool + Send, Self: 'async_trait,

Attempt to find a blob from a Blob where it returns the first blob that was found. A default implementation is given which just queries all blobs via StorageService::blobs and uses the find method.