Struct Vocabulary 

pub struct Vocabulary {
    pub version: u64,
    pub source: String,
    pub count: usize,
    pub obligations: Vec<Obligation>,
}

The vocabulary the distribution ships: every token there is.

count is measured from obligations rather than written down, so a token added to the file is counted by the same act that declares it.

use majordomus_cli::capability::builtin::obligations::Vocabulary;
let v: Vocabulary = serde_json::from_str(
    r#"{"version":1,"source":"/opt/majordomus/share/obligations.yaml","count":1,
        "obligations":[{"id":"commit","title":"The work is committed",
                        "summary":"In the branch's history, not the working tree.",
                        "discharged_by":"git","remote":false}]}"#,
)
.unwrap();
assert_eq!(v.count, v.obligations.len());
assert_eq!(v.version, 1, "the only shape this reader accepts");

Fields

version: u64

The file’s own format version. 1 is the only one this reader accepts.

source: String

Where it was read from, absolute: the distribution’s share directory, which is not necessarily inside the repository.

count: usize

How many tokens there are. No number anywhere is written down.

obligations: Vec<Obligation>

Every token, in the order the file declares them.

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<'de> Deserialize<'de> for Vocabulary

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Vocabulary

impl JsonSchema for Vocabulary

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 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 Serialize for Vocabulary

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 Vocabulary