Struct FileStorage 

pub struct FileStorage {
    pub path: PathBuf,
    pub lock_timeout: Duration,
    /* private fields */
}

Fields

path: PathBuf

Root directory for all stored data.

lock_timeout: Duration

Maximum time to wait when acquiring a lock before returning an error. Defaults to 5 minutes.

Implementations

impl FileStorage

pub fn new(path: impl Into<PathBuf>) -> FileStorage

Create a new FileStorage rooted at the given path.

The path does not need to exist yet – directories will be created on first write. For the platform-appropriate default location, use FileStorage::default() instead.

pub fn with_lock_timeout( path: impl Into<PathBuf>, lock_timeout: Duration, ) -> FileStorage

Create a new FileStorage with a custom lock timeout.

Trait Implementations

impl Default for FileStorage

fn default() -> FileStorage

Create a FileStorage using the platform-appropriate default data directory and the default lock timeout.

impl Display for FileStorage

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

Formats the value using the given formatter.

impl Storage for FileStorage

fn store<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 str, value: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, FileStorage: 'async_trait,

Store value at key, creating the key if it does not exist and overwriting any existing value.

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

where 'life0: 'async_trait, 'life1: 'async_trait, FileStorage: 'async_trait,

Load the value stored at key.

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

where 'life0: 'async_trait, 'life1: 'async_trait, FileStorage: 'async_trait,

Delete the named key. If the key is a directory (prefix of other keys), all keys prefixed by it should be deleted.

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

where 'life0: 'async_trait, 'life1: 'async_trait, FileStorage: 'async_trait,

Returns true if the key exists (as either a file or directory) and there was no error checking.

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

where 'life0: 'async_trait, 'life1: 'async_trait, FileStorage: 'async_trait,

List all keys under path.

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

where 'life0: 'async_trait, 'life1: 'async_trait, FileStorage: 'async_trait,

Return metadata about key.

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

where 'life0: 'async_trait, 'life1: 'async_trait, FileStorage: 'async_trait,

Acquire a distributed lock for name, blocking until it can be obtained or an error occurs.

fn try_lock<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, timeout: Duration, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, FileStorage: 'async_trait,

Try to acquire a distributed lock for name with a timeout.

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

where 'life0: 'async_trait, 'life1: 'async_trait, FileStorage: 'async_trait,

Release the distributed lock for name.