Struct CacheClient 

pub struct CacheClient { /* private fields */ }

GitHub Actions cache client.

See module documentation.

Implementations

impl CacheClient

pub fn builder<B: Into<String>, T: Into<String>>( base_url: B, token: T, ) -> CacheClientBuilder

Creates a new CacheClientBuilder.

See CacheClientBuilder::new.

pub fn from_env() -> Result<CacheClientBuilder>

Creates a new CacheClientBuilder from environmental variables.

See CacheClientBuilder::from_env.

pub fn base_url(&self) -> &str

Gets the GitHub Actions cache API base URL.

See CacheClientBuilder::base_url.

pub fn cache_to(&self) -> Option<&str>

Gets the cache key to write.

See CacheClientBuilder::cache_to.

pub fn cache_from(&self) -> Option<&str>

Gets the cache key prefixes to read.

See CacheClientBuilder::cache_from.

pub async fn entry(&self, version: &str) -> Result<Option<ArtifactCacheEntry>>

Gets the cache entry identified by the given version.

pub async fn get(&self, url: &str) -> Result<Vec<u8>>

Gets the cache archive as a byte array.

pub async fn put<T: Read + Seek>(&self, version: &str, data: T) -> Result<()>

Puts the cache archive as the given version.

Trait Implementations

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.