Enum LedgerError 

pub enum LedgerError {
    UnregisteredEvent {
        name: String,
        file: String,
        known: String,
    },
    MissingField {
        name: String,
        field: String,
    },
    Vocabulary {
        path: String,
        reason: String,
    },
    Io {
        path: String,
        reason: String,
    },
}

What can go wrong writing or reading the ledger. The first two are refusals of a malformed event and happen before anything is written; the last two are the disk.

use majordomus_cli::session::{Envelope, LedgerError, LedgerEvent, Vocabulary};

let v = Vocabulary::parse("version: 1\nevents:\n  - id: session.started\n    requires: [owner]\n    public: true\n").unwrap();
let envelope = Envelope {
    ts: "2026-09-11T11:02:35Z".into(), head: "1a651e64".into(),
    branch: "master".into(), by: "majordomus/0.5.0".into(), session: None,
};
let err = LedgerEvent::new("session.started").render(&v, &envelope).expect_err("a refusal");
assert!(matches!(err, LedgerError::MissingField { .. }));

Variants

UnregisteredEvent

The event name is not one share/events.yaml declares. An internal error and not a finding: a command that writes an event the vocabulary does not define is a bug in Majordomus, not a fact about the repository being supervised.

Fields

name: String

The name that was offered.

file: String

The vocabulary file it is missing from.

known: String

The names that are declared, space separated.

MissingField

The event is declared and the payload is missing a key its declaration requires.

Fields

name: String

The event.

field: String

The key its requires: demands.

Vocabulary

The vocabulary file could not be read or does not parse.

Fields

path: String

Where it was looked for.

reason: String

What went wrong.

Io

The ledger file itself could not be opened, locked or written.

Fields

path: String

The ledger.

reason: String

What went wrong.

Trait Implementations

impl Debug for LedgerError

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

Formats the value using the given formatter.

impl Display for LedgerError

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

Formats the value using the given formatter.

impl Error for LedgerError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.