Struct LocalDir 

pub struct LocalDir { /* private fields */ }

A directory-backed ObjectStore.

Implementations

impl LocalDir

pub fn open(root: impl AsRef<Path>) -> Result<Self>

Open (creating if needed) a store rooted at root.

pub fn with_max_inflated(self, limit: u64) -> Self

Refuse to decode an encoded object past limit bytes (Error::TooLarge); the default is MAX_INFLATED_BYTES.

pub fn root(&self) -> &Path

The root directory.

pub fn precision_ns(&self) -> u64

The probed timestamp precision in nanoseconds (1 on most modern filesystems).

Trait Implementations

impl Debug for LocalDir

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

Formats the value using the given formatter.

impl ObjectStore for LocalDir

type Get<'a> = Ready<Result<Option<Object>, Error>>

Future of get.

type GetRange<'a> = Ready<Result<Bytes, Error>>

Future of get_range.

type Head<'a> = Ready<Result<Option<Meta>, Error>>

Future of head.

type Put<'a> = Ready<Result<u64, Error>>

Future of put.

type List<'a> = Ready<Result<Vec<Meta>, Error>>

Future of list.

type Delete<'a> = Ready<Result<(), Error>>

Future of delete.

fn get<'a>(&'a self, key: &'a str) -> Self::Get<'a>

The whole object, or None if it does not exist.

fn get_range<'a>( &'a self, key: &'a str, range: Range<u64>, ) -> Self::GetRange<'a>

Bytes range of the object. A range running past the end is clipped; a range starting at or past the end is an empty body. A missing object is Error::NotFound.

fn head<'a>(&'a self, key: &'a str) -> Self::Head<'a>

Size and generation, without the body.

fn put<'a>(&'a self, key: &'a str, body: Bytes, cond: Cond) -> Self::Put<'a>

Write body under key if cond holds; returns the new generation.

fn list<'a>(&'a self, prefix: &'a str) -> Self::List<'a>

Every object whose key starts with prefix, sorted by key. An empty prefix lists everything; a non-empty prefix is validated like a key (a trailing / is allowed).

fn delete<'a>(&'a self, key: &'a str) -> Self::Delete<'a>

Remove the object. Deleting a missing key succeeds.

fn put_encoded<'a>( &'a self, key: &'a str, body: Bytes, cond: Cond, encoding: ContentEncoding, ) -> impl Future<Output = Result<u64>> + 'a

Like put, storing body compressed with encoding and recording the encoding, so get returns body again and get_range refuses with Error::EncodedRange. Conditions behave exactly as for put.

fn stat<'a>( &'a self, key: &'a str, ) -> impl Future<Output = Result<Option<Stat>>> + 'a

head plus the content encoding. The default reports none, which is exact for a store that cannot record one.

fn list_stat<'a>( &'a self, prefix: &'a str, ) -> impl Future<Output = Result<Vec<Stat>>> + 'a

list plus each object’s content encoding. The default reports none, which is exact for a store that cannot record one.