Struct EventDeclaration 

#[non_exhaustive]
pub struct EventDeclaration {
    pub name: String,
    pub version: u32,
    pub headers: Vec<String>,
    pub summary: Option<String>,
}

A versioned bus event notice whose body is served by the publisher.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

One NATS subject token: [a-z0-9][a-z0-9_]{0,62}.

This is the event token rule in cortexkit-bus-naming 0.2.0, token.rs, lines 91–143.

version: u32

Event schema version, at least 1.

headers: Vec<String>

Header names every notice carries, for filtering only, never authority. Names match [a-z][a-z0-9_]{0,31} and are unique within the declaration.

summary: Option<String>

Short human line for consent cards, at most 200 characters without controls.

Implementations

impl EventDeclaration

pub fn new(name: impl Into<String>, version: u32) -> Self

Starts an event declaration with no filter headers or summary. Validation happens when decoding a manifest or admitting its HELLO.

pub fn with_headers(self, headers: Vec<String>) -> Self

Sets the header names carried by every notice of this event.

pub fn with_summary(self, summary: Option<String>) -> Self

Sets or removes the short human summary.

Trait Implementations

impl Clone for EventDeclaration

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventDeclaration

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventDeclaration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EventDeclaration

impl PartialEq for EventDeclaration

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for EventDeclaration

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 EventDeclaration