Struct persist::file::FileBlob

pub struct FileBlob {
    core: FileBlobCore,
}

Implementation of Blob backed by files.

Fields

core: FileBlobCore

Implementations

impl FileBlob

const LOCKFILE_PATH: &'static str

fn lockfile_path(base_dir: &Path) -> PathBuf

Trait Implementations

impl Blob for FileBlob

fn open_exclusive(
    config: FileBlobConfig,
    lock_info: LockInfo
) -> Result<Self, Error>

Returns a new FileBlob which stores files under the given dir.

To ensure directory-wide mutual exclusion, a LOCK file is placed in base_dir at construction time. If this file already exists (indicating that another FileBlob is already using the dir), an error is returned.

The contents of lock_info are stored in the LOCK file and should include anything that would help debug an unexpected LOCK file, such as version, ip, worker number, etc.

type Config = FileBlobConfig

The configuration necessary to open this type of storage.

type Read = FileBlobRead

The corresponding BlobRead implementation.

fn open_read(config: FileBlobConfig) -> Result<FileBlobRead, Error>

Opens the given location for non-exclusive read-only access.

fn set<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    key: &'life1 str,
    value: Vec<u8>,
    atomic: Atomicity
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Inserts a key-value pair into the map.

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

Remove a key from the map.

impl BlobRead for FileBlob

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

Returns a reference to the value corresponding to the key.

fn list_keys<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<String>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

List all of the keys in the map.

fn close<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Synchronously closes the blob, causing all future commands to error.

impl Debug for FileBlob

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

Formats the value using the given formatter.