Struct ToolCache 

pub struct ToolCache { /* private fields */ }

Tool Cache

Implementations

impl ToolCache

pub async fn extract_archive( &self, archive: &PathBuf, output: &PathBuf, ) -> Result<(), ToolCacheError>

Extract an archive

impl ToolCache

pub fn new() -> Self

Create a new Tool Cache

This will either use the RUNNER_TOOL_CACHE environment variable or it will try to find the tool cache in the default locations.

There are 3 default locations:

• /opt/hostedtoolcache (Unix)
• /usr/local/share/toolcache (Unix)
• /tmp/toolcache (Unix)
• C:\\hostedtoolcache (Windows)
• C:\\Program Files\\toolcache (Windows)
• C:\\tmp\\toolcache (Windows)

If no locations are found or writeable, it will create a new tool cache in the current directory at ./.toolcache.

pub fn build() -> ToolCacheBuilder

Create a new ToolCacheBuilder

pub fn platform(&self) -> ToolPlatform

Get the platform for the tool cache

By default this is set to the current platform of the system. You can override this by using the platform method on the ToolCacheBuilder.

pub fn arch(&self) -> ToolCacheArch

Get the architecture for the tool cache

By default this is set to the current architecture of the system. You can override this by using the arch method on the ToolCacheBuilder.

pub fn get_tool_cache(&self) -> &PathBuf

Get the Tool Cache Path

This is either set by the RUNNER_TOOL_CACHE environment variable or it is one of the default locations.

pub async fn find( &self, tool: impl Into<String>, version: impl Into<String>, ) -> Result<Tool, ToolCacheError>

Find a tool in the cache

pub async fn find_all_version( &self, tool: impl Into<String>, ) -> Result<Vec<Tool>, ToolCacheError>

Find all versions of a tool in the cache

pub async fn find_with_arch( &self, tool: impl Into<String>, version: impl Into<String>, arch: impl Into<ToolCacheArch>, ) -> Result<Tool, ToolCacheError>

Find a tool in the cache with a specific architecture

pub fn new_tool_path( &self, tool: impl Into<String>, version: impl Into<String>, ) -> PathBuf

Create a path for the tool in the cache to be used

pub fn set_retry_count(&mut self, count: u8)

👎Deprecated since 0.17.0: Use the ToolCacheBuilder instead

Set the number of times to retry a download (default is 10)

Trait Implementations

impl Clone for ToolCache

fn clone(&self) -> ToolCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolCache

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

Formats the value using the given formatter.

impl Default for ToolCache

fn default() -> Self

Returns the “default value” for a type.

impl From<&str> for ToolCache

fn from(cache: &str) -> Self

Converts to this type from the input type.

impl From<PathBuf> for ToolCache

fn from(value: PathBuf) -> Self

Converts to this type from the input type.