Struct LocalBackend 

pub struct LocalBackend { /* private fields */ }

A StorageBackend backed by the local filesystem.

All keys are mapped to paths under the configured base_dir. Parent directories are created automatically on put.

Implementations

impl LocalBackend

pub async fn new(base_dir: impl Into<PathBuf>) -> Result<Self>

Create a new LocalBackend rooted at the given directory.

The directory is created if it does not exist.

pub fn base_dir(&self) -> &Path

Return the base directory.

Trait Implementations

impl Clone for LocalBackend

fn clone(&self) -> LocalBackend

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LocalBackend

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

Formats the value using the given formatter.

impl StorageBackend for LocalBackend

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

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

Write an object. Overwrites if it already exists.

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

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

Read an object. Returns [ApiaryError::NotFound] if the key does not exist.

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

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

List all object keys matching the given prefix.

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

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

Delete an object. Does not error if the key does not exist.

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

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

Conditional write: succeeds only if the key does not already exist.

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

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

Check if an object exists at the given key.