Struct LedgerSummary 

pub struct LedgerSummary {
    pub path: String,
    pub present: bool,
    pub executions: usize,
    pub newest: Option<String>,
    pub commits: Vec<String>,
}

What the ledger is and whether it is there at all.

A report that did not say where its evidence came from would be asking to be believed. This is the provenance of the whole report: the file, how much it holds, how old the newest entry is, and which commits anything was ever recorded against.

use majordomus_cli::evidence::{Ledger, LedgerSummary, LEDGER_PATH};

let summary: LedgerSummary = Ledger::empty().summary();
assert_eq!(summary.path, LEDGER_PATH);
assert!(!summary.present, "a ledger holding nothing has recorded nothing");
assert_eq!(summary.executions, 0);
assert!(summary.newest.is_none());
assert!(summary.commits.is_empty());

Example

use majordomus_cli::evidence::LedgerSummary;
let s = LedgerSummary {
    path: ".ai/repo/evidence/ledger.json".into(),
    present: false,
    executions: 0,
    newest: None,
    commits: vec![],
};
assert!(!s.present, "a repository that recorded nothing says so");

Fields

path: String

Where it lives, repository-relative.

present: bool

Whether the ledger holds at least one execution.

Not whether the file exists. A ledger file holding nothing and no ledger file at all are the same answer to the only question a reader is asking — has anything been recorded — and both make every claim read not_run. Ledger::present answers the filesystem question, and nothing derives a proof state from it.

executions: usize

How many executions it holds.

newest: Option<String>

The newest at in it, when it holds any.

commits: Vec<String>

The distinct commits its executions were recorded against. Always emitted, empty included, for the reason ClaimProof::changed is.

Trait Implementations

impl Clone for LedgerSummary

fn clone(&self) -> LedgerSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LedgerSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LedgerSummary

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for LedgerSummary

impl JsonSchema for LedgerSummary

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 LedgerSummary

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

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 LedgerSummary