Struct Provider 

pub struct Provider {
    pub name: String,
    pub config: StorageProvider,
    pub(crate) provider: Box<DynObjectStore>,
    pub(crate) signer: Option<Arc<dyn Signer>>,
    pub(crate) base_path: Option<Path>,
    startup_check: bool,
    services: Arc<OnceServices>,
}

One configured object-storage backend.

The provider normalizes configured paths and transfer policies before delegating operations to its local or S3-compatible object store. Optional startup checks and URL signing remain backend capabilities.

Fields

name: String

Configuration identifier for this provider.

config: StorageProvider

Backend-specific configuration used to construct this provider.

provider: Box<DynObjectStore>

Erased object-store implementation receiving provider operations.

signer: Option<Arc<dyn Signer>>

Optional backend signer used to create time-limited object URLs.

base_path: Option<Path>

Prefix prepended to logical object paths before backend operations.

startup_check: bool

services: Arc<OnceServices>

Implementations

impl Provider

pub(super) async fn start(self: &Arc<Self>) -> Result

Starts this provider and performs its configured connectivity check.

Providers with startup checks disabled become ready without backend I/O. An enabled check lists at most one object and propagates any backend error.

impl Provider

async fn startup_check(self: &Arc<Self>) -> Result

impl Provider

pub async fn put<S, T>( &self, path: &str, size: Option<usize>, input: S, ) -> Result<PutResult>

where S: Stream<Item = Result<T>> + Send, PutPayload: From<T> + From<PutPayload>,

Stores a streamed object under path.

Supplying the total size permits a single-part upload below the configured threshold. A missing or large size selects multipart upload instead.

impl Provider

pub async fn put_one<T>(&self, path: &str, input: T) -> Result<PutResult>

where PutPayload: From<T> + From<PutPayload>,

Stores one contiguous object under path.

The input length selects single-part or multipart upload against the configured threshold. Backend upload failures are propagated.

impl Provider

async fn put_multi<S, T>(&self, path: &str, input: S) -> Result<PutResult>

where S: Stream<Item = Result<T>> + Send, PutPayload: From<T> + From<PutPayload>,

Stores streamed input through a multipart upload.

Input chunks are written as ordered multipart parts. Upload cleanup and backend failures are delegated to the object-store implementation.

impl Provider

async fn put_single(&self, path: &str, input: PutPayload) -> Result<PutResult>

Stores contiguous input through a single-part upload.

The provider prefix is applied before the backend request. Backend failures are propagated without retrying as multipart upload.

impl Provider

pub fn fetch_with_metadata( &self, path: &str, ) -> impl Stream<Item = Result<FetchMetaItem>> + Send

Streams an object’s bytes together with shared response metadata.

The provider prefix is applied to path, and each successful chunk shares the same range, object metadata, and attributes. Load and stream failures are returned as items rather than being discarded.

impl Provider

pub fn fetch(&self, path: &str) -> impl Stream<Item = Result<FetchItem>> + Send

Streams an object’s bytes together with its returned range and total size.

The provider prefix is applied to path. Load and stream failures are returned as items, allowing callers to consume the body without buffering the complete object.

impl Provider

pub async fn get(&self, path: &str) -> Result<Bytes>

Loads an entire object into one contiguous byte buffer.

The provider prefix is applied before the backend request. Backend and body streaming failures are propagated to the caller.

impl Provider

pub async fn load(&self, path: &str) -> Result<GetResult>

Opens an object and returns the backend’s raw read result.

The provider prefix is applied before the request. Callers can inspect the returned range and metadata or consume its body as a stream.

impl Provider

pub async fn signed_get_url( &self, path: &str, ttl: Duration, ) -> Result<Option<Url>>

Creates a time-limited GET URL when the backend supports signing.

The provider prefix is applied before signing. Backends without a signer, such as local filesystem providers, return None without performing I/O.

impl Provider

pub async fn delete_one(self: &Arc<Self>, path: &str) -> Result

Deletes one object from this provider.

This consumes Self::delete to completion and discards its yielded path. Invalid paths and backend failures are propagated.

impl Provider

pub fn delete<S>( self: &Arc<Self>, paths: S, ) -> impl Stream<Item = Result<Path>> + Send

where S: Stream<Item = String> + Send + 'static,

Lazily deletes each supplied object path.

The provider prefix is applied to every path before it reaches the backend. Invalid paths and backend failures are emitted by the returned stream.

impl Provider

pub async fn rename(&self, src: &str, dst: &str, overwrite: CopyMode) -> Result

Renames an object within this provider.

Both paths receive the provider prefix. CopyMode::Create refuses an existing destination, while CopyMode::Overwrite permits replacement.

impl Provider

pub async fn copy(&self, src: &str, dst: &str, overwrite: CopyMode) -> Result

Copies an object within this provider.

Both paths receive the provider prefix. CopyMode::Create refuses an existing destination, while CopyMode::Overwrite permits replacement.

impl Provider

pub fn list( &self, prefix: Option<&str>, ) -> impl Stream<Item = Result<ObjectMeta>> + Send

Streams object metadata beneath an optional logical prefix.

The configured provider prefix is applied to the backend query and removed from each returned location. Backend failures remain stream items.

impl Provider

pub async fn head(&self, path: &str) -> Result<ObjectMeta>

Returns metadata for one object.

The provider prefix is applied before the backend request. Missing objects and backend failures are propagated.

impl Provider

pub async fn ping(&self) -> Result

Probes whether this provider can service a listing request.

The probe consumes at most the first result, so an empty store succeeds. Any path or backend error is logged and returned.

impl Provider

fn to_abs_path(&self, location: &str) -> Result<Path>

impl Provider

fn prepend_base_path(&self, location: Path) -> Path

impl Provider

fn strip_base_path(&self, location: Path) -> Path

impl Provider

fn multipart_threshold(&self) -> usize

impl Provider

fn multipart_part_size(&self) -> usize

Trait Implementations

impl Debug for Provider

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

Formats the value using the given formatter.