Skip to main content

ObjectStoreClient

Struct ObjectStoreClient 

Source
pub struct ObjectStoreClient { /* private fields */ }
Expand description

Cloneable client for local and S3-compatible object storage.

Implementations§

Source§

impl ObjectStoreClient

Source

pub fn from_config(config: ObjectStoreConfig) -> ObjectStoreResult<Self>

Creates a client from either supported configuration variant.

Source

pub fn local(root: impl Into<PathBuf>) -> ObjectStoreResult<Self>

Creates a local filesystem store and ensures its root exists.

Source

pub fn s3(config: S3ObjectStoreConfig) -> ObjectStoreResult<Self>

Creates an S3-compatible store from validated settings.

Source

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

Overrides the maximum size collected by Self::read_object and Self::read_object_optional.

Source

pub fn object_path(&self, key: &str) -> ObjectStoreResult<ObjectPath>

Validates and converts an object key to a backend path.

Source

pub async fn write_object( &self, key: &str, payload: &[u8], ) -> ObjectStoreResult<()>

Writes or replaces an object.

Source

pub async fn write_bytes( &self, key: &str, payload: Bytes, ) -> ObjectStoreResult<()>

Writes or replaces an object without copying an existing byte buffer.

Source

pub async fn read_object(&self, key: &str) -> ObjectStoreResult<Vec<u8>>

Reads an object or returns ObjectStoreError::NotFound.

Source

pub async fn read_object_optional( &self, key: &str, ) -> ObjectStoreResult<Option<Vec<u8>>>

Reads an object, returning None when it does not exist.

Source

pub async fn read_object_with_limit( &self, key: &str, limit: u64, ) -> ObjectStoreResult<Vec<u8>>

Reads an object into memory with a caller-selected size limit.

Source

pub async fn read_object_optional_with_limit( &self, key: &str, limit: u64, ) -> ObjectStoreResult<Option<Vec<u8>>>

Reads an optional object into memory with a caller-selected size limit.

Source

pub async fn get_object( &self, key: &str, limit: u64, ) -> ObjectStoreResult<GetResult>

Returns the backend read result without collecting its payload.

Consumers can stream payload directly; the backend-reported object size is checked before the result is returned.

Source

pub async fn get_object_optional( &self, key: &str, limit: u64, ) -> ObjectStoreResult<Option<GetResult>>

Returns an optional backend read result without collecting its payload.

Source

pub async fn delete_object(&self, key: &str) -> ObjectStoreResult<()>

Deletes an object; missing objects are treated as already deleted.

Trait Implementations§

Source§

impl Clone for ObjectStoreClient

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ObjectStoreClient

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneAny for T
where T: Any + Clone,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more