Struct FsObjStore 

pub struct FsObjStore { /* private fields */ }

Implementations

impl FsObjStore

pub const KIND: &'static str = "objstore.fs"

The kind of this object store (see ObjStore::kind).

pub fn new(config: FsObjStoreConfig) -> Result<Self, Error>

Trait Implementations

impl Clone for FsObjStore

fn clone(&self) -> FsObjStore

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FsObjStore

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

Formats the value using the given formatter.

impl ObjStore for FsObjStore

fn kind(&self) -> &str

Get a descriptive name for backend implementation.

fn safe_uri(&self) -> &Url

Get a “safe” URI for the store, which does not include any sensitive information like api keys.

fn healthcheck<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Checks if the store is usable.

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

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

Get metadata for a given key.

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

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

Get the value for a given key.

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

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

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

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

Get both the value and metadata for a given key.

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

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

fn generate_download_url<'life0, 'async_trait>( &'life0 self, _args: DownloadUrlArgs, ) -> Pin<Box<dyn Future<Output = Result<Option<Url>, Error>> + Send + 'async_trait>>

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

Generate a download URL for a given key.

fn send_put<'life0, 'async_trait>( &'life0 self, put: Put, ) -> Pin<Box<dyn Future<Output = Result<ObjectMeta, Error>> + Send + 'async_trait>>

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

Store a value under a given key.

fn send_copy<'life0, 'async_trait>( &'life0 self, copy: Copy, ) -> Pin<Box<dyn Future<Output = Result<ObjectMeta, Error>> + Send + 'async_trait>>

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

Copy an existing object to a new key.

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

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

Delete a key from the store.

fn list<'life0, 'async_trait>( &'life0 self, args: ListArgs, ) -> Pin<Box<dyn Future<Output = Result<ObjectMetaPage, Error>> + Send + 'async_trait>>

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

List metadata for a given key.

fn list_keys<'life0, 'async_trait>( &'life0 self, args: ListArgs, ) -> Pin<Box<dyn Future<Output = Result<KeyPage, Error>> + Send + 'async_trait>>

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

List keys in the store.

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

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

List all the keys, optionally filtered by a prefix.

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

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

Delete all keys with a given prefix.

fn list_keys_stream<'a>( &'a self, args: ListArgs, ) -> Pin<Box<dyn Stream<Item = Result<KeyPage, Error>> + Send + 'a>>

fn list_stream( &self, args: ListArgs, ) -> Pin<Box<dyn Stream<Item = Result<ObjectMetaPage, Error>> + Send>>

where Self: Sized + Clone + 'static,

Streaming variant of Self::list: pages through Self::list and yields each metadata page (ObjectMetaPage).

fn purge_all<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Purge all keys in the store.

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

where 'life0: 'async_trait, 'life1: 'async_trait, Self: Sized + 'async_trait, T: 'async_trait + DeserializeOwned,

Get a JSON value from the store.