Struct FilesystemBackend 

pub struct FilesystemBackend<K, V, M = ()>
where
    K: StorageKey,
    V: StorageValue,
    M: StorageMeta,
{ /* private fields */ }

Filesystem storage backend.

Each backend instance is safe for concurrent use. Multiple backend instances or processes must not write to the same directory concurrently.

Implementations

impl<K, V, M> FilesystemBackend<K, V, M>

where K: StorageKey, V: StorageValue, M: StorageMeta,

pub async fn new<P: AsRef<Path>>(base_path: P) -> Result<Self>

Create a new filesystem backend with the given base path.

pub fn with_max_snapshot_bytes(self, max_snapshot_bytes: u64) -> Self

Set the maximum accepted and generated snapshot size in bytes.

A zero-byte limit is permitted but makes every snapshot write fail.

Trait Implementations

impl<K, V, M> StorageBackend for FilesystemBackend<K, V, M>

where K: StorageKey, V: StorageValue, M: StorageMeta,

type Value = V

Value type for the storage

type Key = K

Key type for the storage

type Metadata = M

Metadata type for entries

fn save<'life0, 'life1, 'async_trait>( &'life0 self, entries: &'life1 EntryMap<K, V, M>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Save entries to storage

fn load<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<EntryMap<K, V, M>>> + Send + 'async_trait>>

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

Load entries from storage

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

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

Remove entries for a specific key

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

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

Clear all entries from storage

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

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

Check if storage contains a key

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

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

Get approximate size of storage in bytes

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

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

Compact storage (optional operation for backends that support it)