Enum CachePolicy 

pub enum CachePolicy {
    Disabled,
    Process {
        max_entries: usize,
        ttl_seconds: Option<u64>,
    },
    Generation {
        max_entries: usize,
    },
    Checkout {
        max_entries: usize,
    },
}

Whether, and how, the executor keeps results of this capability. Cache lives in the executor and nowhere else, so MCP, HTTP and the command line share one; the key is the canonical id, the normalised input and the registry fingerprint, so a changed repository never answers from an old entry. The two narrower policies add to the key what the registry fingerprint cannot see: the context’s own reading of the repository (CachePolicy::Generation) and the state of the checkout itself (CachePolicy::Checkout).

Variants

Disabled

Every call runs the handler.

Process

Results are kept in this process’s memory, bounded, for equal inputs.

Fields

max_entries: usize

The most entries kept for this capability; the oldest is evicted first.

ttl_seconds: Option<u64>

Seconds an entry stays valid; None for the life of the process.

Generation

Results are kept for equal inputs while the context that computed them is the one asked: for a capability that is a function of the index and the registry alone, including the git state the index was read at, which the registry fingerprint does not cover. A reload of the repository is a new context, and so a new key.

Fields

max_entries: usize

The most entries kept for this capability; the oldest is evicted first.

Checkout

Results are kept for equal inputs while the context is the same and the checkout is as it was: HEAD, the staging index, the refs and every changed or untracked path of the work tree, fingerprinted again on every call (capability::checkout). For a capability that reads git, the index and the files of the work tree, and nothing that fingerprint cannot see: no ignored file, no other process, no network, no clock. A checkout git cannot fingerprint is not cached.

Fields

max_entries: usize

The most entries kept for this capability; the oldest is evicted first.

Implementations

impl CachePolicy

pub fn validate(&self) -> Result<(), String>

Is the policy well-formed? The reason when it is not.

use majordomus_cli::capability::CachePolicy;
assert!(CachePolicy::Disabled.validate().is_ok());
assert!(CachePolicy::Process { max_entries: 0, ttl_seconds: None }.validate().is_err());
assert!(CachePolicy::Checkout { max_entries: 0 }.validate().is_err());
assert!(CachePolicy::Generation { max_entries: 4 }.validate().is_ok());

pub fn is_enabled(&self) -> bool

Does the policy keep anything?

pub fn max_entries(&self) -> Option<usize>

The most entries the policy keeps per capability; None when it keeps nothing.

use majordomus_cli::capability::CachePolicy;
assert_eq!(CachePolicy::Disabled.max_entries(), None);
assert_eq!(CachePolicy::Checkout { max_entries: 2 }.max_entries(), Some(2));

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

Seconds an entry stays valid; None for as long as its key holds.

use majordomus_cli::capability::CachePolicy;
let p = CachePolicy::Process { max_entries: 2, ttl_seconds: Some(5) };
assert_eq!(p.ttl_seconds(), Some(5));
assert_eq!(CachePolicy::Generation { max_entries: 2 }.ttl_seconds(), None);

pub fn summary(&self) -> String

The policy in a few words, as the Cockpit and the generated catalogue print it.

use majordomus_cli::capability::CachePolicy;
assert_eq!(CachePolicy::Disabled.summary(), "—");
assert_eq!(
    CachePolicy::Process { max_entries: 8, ttl_seconds: Some(5) }.summary(),
    "process, 8 entries, 5s"
);
assert_eq!(
    CachePolicy::Checkout { max_entries: 4 }.summary(),
    "process, 4 entries, per checkout state"
);

Trait Implementations

impl Clone for CachePolicy

fn clone(&self) -> CachePolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CachePolicy

impl Debug for CachePolicy

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CachePolicy

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CachePolicy

impl JsonSchema for CachePolicy

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for CachePolicy

fn eq(&self, other: &CachePolicy) -> 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 Serialize for CachePolicy

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 CachePolicy