Struct ProtocolDescriptor 

pub struct ProtocolDescriptor {
    pub descriptor_version: u32,
    pub namespace: String,
    pub version: u32,
    pub types: TypeTable,
    pub state: Vec<StateField>,
    pub commands: Vec<CommandSpec>,
    pub events: Vec<EventSpec>,
    pub modules: Vec<String>,
}

The complete, versioned description of one application protocol: its types, read-only state snapshot and command catalog.

Fields

descriptor_version: u32

namespace: String

version: u32

Catalog version chosen by the application.

types: TypeTable

state: Vec<StateField>

commands: Vec<CommandSpec>

events: Vec<EventSpec>

Events this protocol emits, in declaration order.

modules: Vec<String>

Namespaces of the modules composed into this catalog, in order. Their commands keep their own namespace in their ids, and each module’s state is the state field of the same name.

Implementations

impl ProtocolDescriptor

pub fn command(&self, id: &str) -> Option<(usize, &CommandSpec)>

pub fn command_symbol(&self, command: &CommandSpec) -> String

A name for command that is unique in this catalog, for generated code: the command’s own name in the application’s namespace, the namespace and name joined by _ in a module’s, such as downloads_add.

pub fn state_index(&self, name: &str) -> Option<usize>

pub fn fingerprint(&self) -> u64

Stable fingerprint of the full descriptor. Peers compare it during the handshake so a stale client cannot silently use another catalog.

pub fn validate(&self) -> Result<(), DescriptorError>

Trait Implementations

impl Clone for ProtocolDescriptor

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 ProtocolDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProtocolDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ProtocolDescriptor

impl PartialEq for ProtocolDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProtocolDescriptor

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 ProtocolDescriptor