CacheClientBuilder

Struct CacheClientBuilder 

Source
pub struct CacheClientBuilder {
Show 15 fields 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,
}
Expand description

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§

Source§

impl CacheClientBuilder

Source

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.

Source

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
Source

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

Sets the GitHub Actions cache API base URL.

Source

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

Sets the cache key prefixes to read.

Source

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

Sets the user agent for HTTP requests.

Source

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

Sets the cache key to write.

Source

pub fn cache_from<T>(self, cache_from: T) -> Self
where T: Iterator, T::Item: Into<String>,

Sets the cache key prefixes to read.

Source

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

Sets the maximum number of retries.

Source

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

Sets the minimum retry interval.

Source

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

Sets the maximum retry interval.

Source

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

Sets the retry backoff factor base.

Source

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

Maximum chunk size in bytes for downloads.

Source

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

Sets the maximum time for each chunk download request.

Source

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

Sets the number of parallel downloads.

Source

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

Sets the maximum chunk size in bytes for uploads.

Source

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

Sets the maximum time for each chunk upload request.

Source

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

Sets the number of parallel downloads.

Source

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

Consumes this CacheClientBuilder and build a CacheClient.

Trait Implementations§

Source§

impl Clone for CacheClientBuilder

Source§

fn clone(&self) -> CacheClientBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CacheClientBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CacheClientBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for CacheClientBuilder

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl TryInto<CacheClient> for CacheClientBuilder

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl Eq for CacheClientBuilder

Source§

impl StructuralPartialEq for CacheClientBuilder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more