Struct CachingClient

pub struct CachingClient<T> { /* private fields */ }

A client that caches response data using the given cache implementation. Can be used without an underlying client to be used as a read-only cache.

Implementations

impl<T: Cache> CachingClient<T>

pub fn new(client: Option<Client>, cache: T) -> Self

Creates a new caching client from the given client and cache implementation. If no client is given, the client will be in offline or read-only mode, meaning it will only be able to return things that are already in the cache.

pub fn is_readonly(&self) -> bool

Returns whether or not the client is in read-only mode.

pub async fn list_all_versions( &self, package: &PackageRef, ) -> Result<Vec<VersionInfo>, Error>

Returns a list of all package VersionInfos available for the given package. This will always fail if no client was provided.

pub async fn get_release( &self, package: &PackageRef, version: &Version, ) -> Result<Release, Error>

Returns a Release for the given package version.

pub async fn get_content( &self, package: &PackageRef, release: &Release, ) -> Result<ContentStream, Error>

Returns a ContentStream of content chunks. If the data is in the cache, it will be returned, otherwise it will be fetched from an upstream registry and then cached. This is the same as Client::stream_content but named differently to avoid confusion when trying to use this as a normal Client.

pub fn client(&self) -> Result<&Client, Error>

Returns a reference to the underlying client. Returns an error if the client is in read-only mode.

Please note that using the client directly will bypass the cache.

pub fn into_client(self) -> Result<Client, Error>

Consumes the caching client and returns the underlying client. Returns an error if the client is in read-only mode.

Trait Implementations

impl<T: Cache> Clone for CachingClient<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.