Struct CacheClientBuilder 

pub struct CacheClientBuilder {

    pub base_url: String,
    pub token: String,
    pub user_agent: String,
    pub cache_to: Option<String>,
    pub cache_from: Vec<String>,
    pub max_retries: u32,
    pub min_retry_interval: Duration,
    pub max_retry_interval: Duration,
    pub backoff_factor_base: u32,
    pub download_chunk_size: u64,
    pub download_chunk_timeout: Duration,
    pub download_concurrency: u32,
    pub upload_chunk_size: u64,
    pub upload_chunk_timeout: Duration,
    pub upload_concurrency: u32,
}

GitHub Actions cache client builder.

See module documentation.

Fields

base_url: String

GitHub Actions cache API base URL.

token: String

GitHub Actions access token.

user_agent: String

User agent for HTTP requests.

cache_to: Option<String>

Cache key to write.

cache_from: Vec<String>

Cache key prefixes to read.

max_retries: u32

Maximum number of retries.

min_retry_interval: Duration

Minimum retry interval. See ExponentialBackoff::min_retry_interval.

max_retry_interval: Duration

Maximum retry interval. See ExponentialBackoff::max_retry_interval.

backoff_factor_base: u32

Retry backoff factor base. See ExponentialBackoff::backoff_exponent.

download_chunk_size: u64

Maximum chunk size in bytes for downloads.

download_chunk_timeout: Duration

Maximum time for each chunk download request.

download_concurrency: u32

Number of parallel downloads.

upload_chunk_size: u64

Maximum chunk size in bytes for uploads.

upload_chunk_timeout: Duration

Maximum time for each chunk upload request.

upload_concurrency: u32

Number of parallel uploads.

Implementations

impl CacheClientBuilder

pub fn new<B: Into<String>, T: Into<String>>(base_url: B, token: T) -> Self

Creates a new CacheClientBuilder for the given GitHub Actions cache API base URL and access token.

pub fn from_env() -> Result<Self>

Creates a new CacheClientBuilder from GitHub Actions cache environmental variables.

The following environmental variables are read:

• ACTIONS_CACHE_URL - GitHub Actions cache API base URL
• ACTIONS_RUNTIME_TOKEN - GitHub Actions access token
• SEGMENT_DOWNLOAD_TIMEOUT_MINS - download chunk timeout

pub fn base_url<T: Into<String>>(self, base_url: T) -> Self

Sets the GitHub Actions cache API base URL.

pub fn token<T: Into<String>>(self, token: T) -> Self

Sets the cache key prefixes to read.

pub fn user_agent<T: Into<String>>(self, user_agent: T) -> Self

Sets the user agent for HTTP requests.

pub fn cache_to<T: Into<String>>(self, cache_to: T) -> Self

Sets the cache key to write.

pub fn cache_from<T>(self, cache_from: T) -> Self

where T: Iterator, T::Item: Into<String>,

Sets the cache key prefixes to read.

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

Sets the maximum number of retries.

pub fn min_retry_interval(self, min_retry_interval: Duration) -> Self

Sets the minimum retry interval.

pub fn max_retry_interval(self, max_retry_interval: Duration) -> Self

Sets the maximum retry interval.

pub fn backoff_factor_base(self, backoff_factor_base: u32) -> Self

Sets the retry backoff factor base.

pub fn download_chunk_size(self, download_chunk_size: u64) -> Self

Maximum chunk size in bytes for downloads.

pub fn download_chunk_timeout(self, download_chunk_timeout: Duration) -> Self

Sets the maximum time for each chunk download request.

pub fn download_concurrency(self, download_concurrency: u32) -> Self

Sets the number of parallel downloads.

pub fn upload_chunk_size(self, upload_chunk_size: u64) -> Self

Sets the maximum chunk size in bytes for uploads.

pub fn upload_chunk_timeout(self, upload_chunk_timeout: Duration) -> Self

Sets the maximum time for each chunk upload request.

pub fn upload_concurrency(self, upload_concurrency: u32) -> Self

Sets the number of parallel downloads.

pub fn build(self) -> Result<CacheClient>

Consumes this CacheClientBuilder and build a CacheClient.

Trait Implementations

impl Clone for CacheClientBuilder

fn clone(&self) -> CacheClientBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheClientBuilder

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

Formats the value using the given formatter.

impl Default for CacheClientBuilder

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CacheClientBuilder

fn eq(&self, other: &CacheClientBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryInto<CacheClient> for CacheClientBuilder

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<CacheClient, Self::Error>

Performs the conversion.

impl Eq for CacheClientBuilder

impl StructuralPartialEq for CacheClientBuilder