Struct mz_persist::file::FileBlob

pub struct FileBlob {
    base_dir: PathBuf,
    tombstone: bool,
}

Implementation of Blob backed by files.

Fields

base_dir: PathBuf

tombstone: bool

Implementations

impl FileBlob

pub async fn open(config: FileBlobConfig) -> Result<Self, ExternalError>

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

fn blob_path(&self, key: &str) -> PathBuf

fn replace_forward_slashes(key: &str) -> String

For simplicity, FileBlob maintains a single flat directory of blobs. Because files can never use forward slashes in their names on Linux, even if escaped, we replace forward slashes with a Unicode character that looks substantially similar, so the file name is not interpreted as part of a directory structure. This is helpful for compatibility with clients who are expecting an S3-like interface that both use a flat hierarchy and allow forward slashes in file names.

(And apologies to the callers who really did want to use U+2215 code points in their filenames.)

fn restore_forward_slashes(key: &str) -> String

Trait Implementations

impl Blob for FileBlob

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

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

Returns a reference to the value corresponding to the key.

fn list_keys_and_metadata<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key_prefix: &'life1 str, f: &'life2 mut (dyn FnMut(BlobMetadata<'_>) + Send + Sync), ) -> Pin<Box<dyn Future<Output = Result<(), ExternalError>> + Send + 'async_trait>>

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

List all of the keys in the map with metadata about the entry.

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

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

Inserts a key-value pair into the map.

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

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

Remove a key from the map.

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

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

Restores a previously-deleted key to the map, if possible.

impl Debug for FileBlob

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

Formats the value using the given formatter.