Struct CacheConfig 

pub struct CacheConfig {
    pub enabled: Option<bool>,
    pub root: Option<String>,
    pub max_size_gib: Option<u64>,
    pub tools: BTreeMap<String, bool>,
    pub targets: BTreeMap<String, TargetCacheConfig>,
}

caches.toml: what an operator changed from the defaults. Everything is optional; an absent file is every default.

Fields

enabled: Option<bool>

false turns caches off for every policy on this host.

root: Option<String>

The cache root, replacing <runner root>/_cache.

max_size_gib: Option<u64>

The cap on the whole root; 0 means no cap.

tools: BTreeMap<String, bool>

Tools switched on or off for every policy, by id.

targets: BTreeMap<String, TargetCacheConfig>

Per-target settings, keyed by owner/repo or the organization, in lower case.

Implementations

impl CacheConfig

pub fn parse(text: &str, path: &Path) -> Result<Self, CacheError>

Parses and validates the file’s text.

Errors

Malformed TOML, an unknown key or tool, an invalid namespace, target or root.

pub fn load(path: &Path) -> Result<Self, CacheError>

Reads path; a file that does not exist is every default.

Errors

As Self::parse, and CacheError::Io when it cannot be read.

pub fn save(&self, path: &Path) -> Result<(), CacheError>

Writes the file atomically, after validating it, removing target sections that no longer say anything.

Errors

CacheError::Io, or a value that would not load back.

pub fn target(&self, target: &ScaleTarget) -> Option<&TargetCacheConfig>

The settings for target, if any.

pub fn target_mut(&mut self, target: &ScaleTarget) -> &mut TargetCacheConfig

The settings for target, created empty if absent.

pub fn max_bytes(&self) -> Option<u64>

The cap in bytes; None when there is none.

pub fn host_enabled(&self) -> bool

Whether caches are on for this host at all.

Trait Implementations

impl Clone for CacheConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheConfig

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

Formats the value using the given formatter.

impl Default for CacheConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CacheConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CacheConfig

impl PartialEq for CacheConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CacheConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CacheConfig