Struct DeclaredEvent 

pub struct DeclaredEvent {
    pub id: String,
    pub emitted_by: String,
    pub requires: Vec<String>,
    pub public: bool,
}

One declared event: what it is called, what writes it, what it must carry, and whether it is part of the documented record a user reads back.

use majordomus_cli::session::{DeclaredEvent, Vocabulary};

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");
let declared: &DeclaredEvent = &v.declared()[0];
assert_eq!(declared.id, "session.closed");
assert_eq!(declared.requires, ["outcome", "session_path"]);

Fields

id: String

The name written into the event field of every line.

emitted_by: String

The command whose module writes it.

requires: Vec<String>

Payload keys every line of this type must carry, beyond the envelope.

public: bool

Whether the event is part of the documented record a user reads back.

Trait Implementations

impl Clone for DeclaredEvent

fn clone(&self) -> DeclaredEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeclaredEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeclaredEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DeclaredEvent

impl JsonSchema for DeclaredEvent

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 Ordered for DeclaredEvent

fn order_key(&self) -> OrderKey<'_>

The four parts this item is ordered by. Borrowed from the item: building a key allocates nothing, so sorting a large collection costs the comparisons and no more.

impl PartialEq for DeclaredEvent

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

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 DeclaredEvent