Struct LocalFsStore 

pub struct LocalFsStore { /* private fields */ }

Implements the object-store contract on a Unix-family local directory.

Replacements are atomic: a concurrent reader observes either the complete prior object or the complete replacement, never a missing or partial object.

Implementations

impl LocalFsStore

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

Opens a local store, creating its root directory when necessary.

Construction fails outside Unix-family platforms, where the provider does not claim atomic rename-replace support, or when the root cannot be created.

pub fn with_key_prefix( root: impl Into<PathBuf>, key_prefix: Option<&str>, ) -> Result<Self>

Opens a local store whose keys are confined beneath key_prefix, matching how the provider adapters scope theirs.

pub fn root(&self) -> &Path

Returns the filesystem directory beneath which validated object keys are resolved.

Trait Implementations

impl Debug for LocalFsStore

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

Formats the value using the given formatter.

impl ObjectStore for LocalFsStore

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

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

The reference provider stores no checksum beside an object, so it computes one from the object it holds. That is the same guarantee a cloud provider’s stored checksum gives — the provider attesting to the bytes it actually has — and it never crosses a network.

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

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

Reads metadata for one key, returning None when the object is absent.

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

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

Reads complete bytes and identity metadata from one self-consistent observation.

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

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

Reads a full object or one half-open byte range, returning None when absent.

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

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

Writes bytes under the requested overwrite or provider-enforced precondition.

fn put_streamed<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, body: ByteStream, mode: PutMode, ) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>

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

Writes a payload of unknown length without holding it whole, and reports how many bytes were stored.

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,

Deletes a key idempotently and makes its absence immediately authoritative.

fn list_prefix_stream(&self, prefix: &str) -> BoxStream<'static, Result<String>>

Streams keys under prefix in ascending lexicographic order.

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

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

Opens a provider multipart upload targeting key, whose eventual checksum covers the whole assembled object.

fn complete_multipart_upload<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, key: &'life1 str, provider_upload_id: &'life2 str, parts: &'life3 [MultipartPart], full_object_checksum: &'life4 StorageChecksum, ) -> Pin<Box<dyn Future<Output = Result<MultipartCompletion>> + Send + 'async_trait>>

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

Asks the provider to assemble parts into the object at key.

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

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

Abandons a provider multipart upload and the parts it accumulated.

fn list_prefix<'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,

Collects and sorts every key under prefix.

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

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

Writes bytes unconditionally, replacing any existing object at key.

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

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

Creates key only when no object is present.

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

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

Writes bytes under an immutable key and accepts success only when the key contains exactly those bytes.

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

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

Replaces key only while its current opaque token equals expected_etag.