Struct CacheClientStore 

pub struct CacheClientStore { /* private fields */ }

Implementations

impl CacheClientStore

pub fn new( cache_base_url: String, api_key: Option<String>, direct: Arc<dyn ObjectStore>, ) -> CacheClientStore

pub fn with_config( cache_base_url: String, api_key: Option<String>, direct: Arc<dyn ObjectStore>, config: CacheClientConfig, ) -> CacheClientStore

Like new, but with an explicit CacheClientConfig instead of reading the environment – what tests use to install short timeouts and a controllable cooldown.

pub async fn prefetch( &self, items: Vec<PrefetchItem>, ) -> Result<PrefetchResponse, Error>

POST a batch of keys to warm at the cache server’s prefetch priority. Best-effort: there is no demand read to fall back to, so callers should treat an Err as “the warm didn’t happen” and move on rather than retrying inline.

Gated on admit_bypass_only(), not admit(): prefetch never closes the circuit and must not be able to consume the single per-cooldown probe slot a demand read would otherwise receive – see “Prefetch does not close the circuit”.

pub async fn send_ranges( &self, location: &Path, ranges: &[Range<u64>], ) -> Result<Vec<Bytes>, RangesSendError>

Issue POST /ranges and reassemble the framed response body, keeping four failure kinds distinct instead of folding them into one: header-phase failure (Send, reusing send’s own abandon_timeout wrap and reporting), a non-2xx Status, and each RangesReadError body-failure kind (Transport/Stalled/Truncated). Only a Send failure or a body Transport/Stalled counts as a breaker failure; a non-2xx Status or a Truncated body means a full HTTP response arrived cheaply, so both report record_responsive per “Abandon vs. unresponsive”. Success – the framed body fully resolving – is the single success report for the whole get_ranges operation, made here because read_framed_ranges exposes nothing to the caller until it fully resolves.

Trait Implementations

impl Debug for CacheClientStore

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

Formats the value using the given formatter.

impl Display for CacheClientStore

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

Formats the value using the given formatter.

impl ObjectPrefetch for CacheClientStore

fn prefetch<'life0, 'async_trait>( &'life0 self, items: Vec<PrefetchItem>, ) -> Pin<Box<dyn Future<Output = Result<PrefetchResponse, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, CacheClientStore: 'async_trait,

impl ObjectStore for CacheClientStore

fn put_opts<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, payload: PutPayload, opts: PutOptions, ) -> Pin<Box<dyn Future<Output = Result<PutResult, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, CacheClientStore: 'async_trait,

Save the provided payload to location with the given options

fn put_multipart_opts<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, opts: PutMultipartOptions, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn MultipartUpload>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, CacheClientStore: 'async_trait,

Perform a multipart upload with options

fn get_opts<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, options: GetOptions, ) -> Pin<Box<dyn Future<Output = Result<GetResult, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, CacheClientStore: 'async_trait,

Perform a get request with options

fn get_ranges<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, location: &'life1 Path, ranges: &'life2 [Range<u64>], ) -> Pin<Box<dyn Future<Output = Result<Vec<Bytes>, Error>> + Send + 'async_trait>>

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

Return the bytes that are stored at the specified location in the given byte ranges

fn delete_stream( &self, locations: Pin<Box<dyn Stream<Item = Result<Path, Error>> + Send>>, ) -> Pin<Box<dyn Stream<Item = Result<Path, Error>> + Send>>

Delete all the objects at the specified locations

fn list( &self, prefix: Option<&Path>, ) -> Pin<Box<dyn Stream<Item = Result<ObjectMeta, Error>> + Send>>

List all the objects with the given prefix.

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

where 'life0: 'async_trait, 'life1: 'async_trait, CacheClientStore: 'async_trait,

List objects with the given prefix and an implementation specific delimiter. Returns common prefixes (directories) in addition to object metadata.

fn copy_opts<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, options: CopyOptions, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Copy an object from one path to another in the same object store.

fn list_with_offset( &self, prefix: Option<&Path>, offset: &Path, ) -> Pin<Box<dyn Stream<Item = Result<ObjectMeta, Error>> + Send>>

List all the objects with the given prefix and a location greater than offset

fn rename_opts<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, options: RenameOptions, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Move an object from one path to another in the same object store.