Skip to main content

CacheStorage

http_cache_stream::storage

Trait CacheStorage 

Source 
pub trait CacheStorage:
    Send
    + Sync
    + 'static {
    // Required methods
    fn get<B: Body + Send>(
        &self,
        key: &str,
    ) -> impl Future<Output = Result<Option<StoredResponse<B>>>> + Send;
    fn put(
        &self,
        key: &str,
        parts: &Parts,
        policy: &CachePolicy,
        digest: &str,
    ) -> impl Future<Output = Result<()>> + Send;
    fn store<B: Body + Send>(
        &self,
        key: String,
        parts: Parts,
        body: B,
        policy: CachePolicy,
    ) -> impl Future<Output = Result<Response<CacheBody<B>>>> + Send;
    fn delete(&self, key: &str) -> impl Future<Output = Result<()>> + Send;
    fn body_path(&self, digest: &str) -> PathBuf;
}
Expand description

A trait implemented on cache storage.

Cache keys are strings of hexadecimal characters.

Required Methods§

Source

fn get<B: Body + Send>( &self, key: &str, ) -> impl Future<Output = Result<Option<StoredResponse<B>>>> + Send

Gets a previously stored response for the given response key.

Returns Ok(None) if a response does not exist in the storage for the given response key.

Source

fn put( &self, key: &str, parts: &Parts, policy: &CachePolicy, digest: &str, ) -> impl Future<Output = Result<()>> + Send

Puts a response with an existing content digest into the storage for the given response key.

The provided content digest must come from a previous call to CacheStorage::get.

Source

fn store<B: Body + Send>( &self, key: String, parts: Parts, body: B, policy: CachePolicy, ) -> impl Future<Output = Result<Response<CacheBody<B>>>> + Send

Stores a new response body in the cache.

Returns a response with a body streaming to the cache.

Source

fn delete(&self, key: &str) -> impl Future<Output = Result<()>> + Send

Deletes a previously cached response for the given response key.

Deleting an unknown key is not considered an error.

Source

fn body_path(&self, digest: &str) -> PathBuf

Gets the path to a response body for the given content digest.

This method does not verify the content’s existence.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§