Struct ObjectStoreClient 

pub struct ObjectStoreClient { /* private fields */ }

The single concrete ObjectOps implementation.

It wraps any object_store::ObjectStore handle, for example a handle from build_object_store, or an object_store::memory::InMemory handle in tests.

Implementations

impl ObjectStoreClient

pub fn new(inner: Arc<dyn ObjectStore>) -> Self

Wrap an existing object-store handle.

Trait Implementations

impl Clone for ObjectStoreClient

fn clone(&self) -> ObjectStoreClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ObjectOps for ObjectStoreClient

fn put_from_path<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 Path, src: &'life2 Path, threshold: u64, chunk_size: usize, req: PutRequest, ) -> Pin<Box<dyn Future<Output = Result<PutOutcome, ObjectStoreError>> + Send + 'async_trait>>

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

Upload a local file. The method uses single-PUT below threshold bytes, and streaming multipart in chunk_size parts at or above threshold.

fn put<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 Path, bytes: Bytes, req: PutRequest, ) -> Pin<Box<dyn Future<Output = Result<PutOutcome, ObjectStoreError>> + Send + 'async_trait>>

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

Single-PUT an in-memory payload under the preconditions in req.

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

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

Fetch a whole object.

fn get_capped<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 Path, max_bytes: u64, ) -> Pin<Box<dyn Future<Output = Result<Bytes, ObjectStoreError>> + Send + 'async_trait>>

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

Fetch a whole object with a byte limit enforced before buffering its body.

fn get_range<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 Path, range: GetRange, ) -> Pin<Box<dyn Future<Output = Result<Bytes, ObjectStoreError>> + Send + 'async_trait>>

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

Fetch a byte range of an object.

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

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

Fetch object metadata, such as the size and the etag.

fn list<'life0, 'async_trait>( &'life0 self, prefix: Option<Path>, ) -> Pin<Box<dyn Future<Output = Result<Vec<ObjectMeta>, ObjectStoreError>> + Send + 'async_trait>>

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

List objects under an optional prefix, collecting the whole listing.

fn list_stream( &self, prefix: Option<Path>, ) -> BoxStream<'static, Result<ObjectMeta, ObjectStoreError>>

List objects under an optional prefix as a stream, one object at a time, so a caller never holds the whole listing at once.

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

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

Delete an object.