Struct cached_path::CacheBuilder

pub struct CacheBuilder { /* fields omitted */ }

Builder to facilitate creating Cache objects.

Implementations

impl CacheBuilder

pub fn new() -> CacheBuilder

Construct a new CacheBuilder.

pub fn with_client_builder(client_builder: ClientBuilder) -> CacheBuilder

Construct a new CacheBuilder with a ClientBuilder.

pub fn dir(mut self: Self, dir: PathBuf) -> CacheBuilder

Set the cache location. This can be set through the environment variable RUST_CACHED_PATH_ROOT. Otherwise it will default to a subdirectory named 'cache' of the default system temp directory.

pub fn client_builder(
    mut self: Self,
    client_builder: ClientBuilder
) -> CacheBuilder

Set the ClientBuilder.

pub fn timeout(mut self: Self, timeout: Duration) -> CacheBuilder

Enable a request timeout.

pub fn connect_timeout(mut self: Self, timeout: Duration) -> CacheBuilder

Enable a timeout for the connect phase of each HTTP request.

pub fn max_retries(mut self: Self, max_retries: u32) -> CacheBuilder

Set maximum number of retries for HTTP requests.

pub fn max_backoff(mut self: Self, max_backoff: u32) -> CacheBuilder

Set the maximum backoff delay in milliseconds for retrying HTTP requests.

pub fn freshness_lifetime(
    mut self: Self,
    freshness_lifetime: u64
) -> CacheBuilder

Set the default freshness lifetime, in seconds. The default is None, meaning the ETAG for an external resource will always be checked for a fresher value.

pub fn offline(mut self: Self, offline: bool) -> CacheBuilder

Only use offline functionality.

If set to true, when the cached path of an HTTP resource is requested, the latest cached version is returned without checking for freshness. But if no cached versions exist, a NoCachedVersions error is returned.

pub fn progress_bar(
    mut self: Self,
    progress_bar: Option<ProgressBar>
) -> CacheBuilder

Set the type of progress bar to use.

The default is Some(ProgressBar::Full).

pub fn build(self) -> Result<Cache, Error>

Build the Cache object.

Trait Implementations

impl Debug for CacheBuilder

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

Formats the value using the given formatter.

impl Default for CacheBuilder

fn default() -> Self

Returns the "default value" for a type.