Struct Vocabulary 

pub struct Vocabulary { /* private fields */ }

The event vocabulary, read from share/events.yaml.

use majordomus_cli::session::Vocabulary;

// written as the shipped file is, which is what a repository's own share directory holds
let v = Vocabulary::parse(
    "version: 1\nevents:\n  - id: session.closed\n    emitted_by: session\n    requires: [outcome, session_path]\n    public: true\n",
).expect("a vocabulary");
assert!(v.knows("session.closed"));
assert!(!v.knows("session.clsoed"), "a typo is not a name");
assert_eq!(v.requires("session.closed"), ["outcome", "session_path"]);
assert!(v.requires("nothing.declared").is_empty());

Implementations

impl Vocabulary

pub fn load(share_dir: &Path) -> Result<Self, LedgerError>

Read the vocabulary from a share directory — the one the tool was invoked with, never a copy compiled into this module.

use majordomus_cli::session::Vocabulary;
// a directory with no events.yaml is a failure with a path in it, not a default
let empty = tempfile::tempdir().unwrap();
assert!(Vocabulary::load(empty.path()).is_err());

pub fn parse(text: &str) -> Result<Self, String>

Parse the vocabulary from the file’s text. A document that declares no event with an id is an error rather than an empty vocabulary, because an empty one would refuse every event and read as “the ledger is broken”.

use majordomus_cli::session::Vocabulary;
assert!(Vocabulary::parse("version: 1\nevents: []\n").is_err());
assert!(Vocabulary::parse("version: 1\nevents:\n  - id: session.started\n").is_ok());

pub fn knows(&self, name: &str) -> bool

Is name declared? The question mj_ledger_append asks before it writes, so that a mistyped name is a refusal rather than a durable line every reader ignores.

use majordomus_cli::session::Vocabulary;
let v = Vocabulary::parse("version: 1\nevents:\n  - id: session.closed\n").unwrap();
assert!(v.knows("session.closed"));
assert!(!v.knows("session.clsoed"), "a typo is not a name");

pub fn requires(&self, name: &str) -> &[String]

The payload keys name must carry. Empty for a name that is not declared — the caller has already been told by Vocabulary::knows, and answering “no requirements” for an unknown name is what keeps this from being a second refusal.

use majordomus_cli::session::Vocabulary;
let v = Vocabulary::parse(
    "version: 1\nevents:\n  - id: session.closed\n    requires: [outcome, session_path]\n",
).unwrap();
assert_eq!(v.requires("session.closed"), ["outcome", "session_path"]);
assert!(v.requires("nothing.declared").is_empty());

pub fn declared(&self) -> Vec<DeclaredEvent>

Every declared event, in the crate’s one canonical order, so two surfaces listing the vocabulary list it the same way.

use majordomus_cli::session::Vocabulary;
let v = Vocabulary::parse(
    "version: 1\nevents:\n  - id: session.started\n  - id: session.closed\n",
).unwrap();
assert_eq!(v.declared().len(), 2);

Trait Implementations

impl Clone for Vocabulary

fn clone(&self) -> Vocabulary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vocabulary

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

Formats the value using the given formatter.

impl Default for Vocabulary

fn default() -> Vocabulary

Returns the “default value” for a type.

impl Eq for Vocabulary

impl PartialEq for Vocabulary

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