Struct Vocabulary 

pub struct Vocabulary { /* private fields */ }

The event vocabulary, read once and shared.

use majordomus_cli::ledger::Vocabulary;
// The default is empty, and an empty vocabulary accepts nothing: a writer that could
// not read the declaration refuses every name rather than allowing any.
let v = Vocabulary::default();
assert!(v.ids().is_empty());
assert!(v.requires("plan_start").is_none());

Implementations

impl Vocabulary

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

Read share/events.yaml.

The file ships with the tool, so a repository never carries its own: a name this executable does not know is a name nothing in the distribution writes.

use majordomus_cli::ledger::Vocabulary;
let v = Vocabulary::load(&f).unwrap();
assert_eq!(v.ids(), ["plan_done"]);
assert_eq!(v.requires("plan_done"), Some(&["issue".to_string()][..]));

// A file that is not there is an error, never an empty vocabulary that accepts all.
assert!(Vocabulary::load(std::path::Path::new("/nonexistent/events.yaml")).is_err());

pub fn ids(&self) -> &[String]

Every declared name, in declaration order. What a refusal lists.

pub fn requires(&self, event: &str) -> Option<&[String]>

The keys a line of this event must carry, or None when the name is not declared.

None and Some(&[]) are different answers: the first is a name nothing declares, the second a declared event whose envelope is all it needs.

use majordomus_cli::ledger::Vocabulary;
assert!(Vocabulary::default().requires("nothing").is_none());

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.