Struct CodebaseMachine 

pub struct CodebaseMachine {
    pub index: usize,
    pub module_path: &'static str,
    pub rust_type_path: &'static str,
    pub role: CodebaseMachineRole,
    pub label: Option<&'static str>,
    pub description: Option<&'static str>,
    pub docs: Option<&'static str>,
    pub states: Vec<CodebaseState>,
    pub transitions: Vec<CodebaseTransition>,
    pub validator_entries: Vec<CodebaseValidatorEntry>,
}

One machine family in the codebase export surface.

Fields

index: usize

Stable codebase-local machine index.

module_path: &'static str

module_path!() for the source module that owns the machine.

rust_type_path: &'static str

Fully qualified Rust type path for the machine family.

role: CodebaseMachineRole

Whether this machine is a local protocol machine or a composition machine.

label: Option<&'static str>

Optional human-facing machine label.

description: Option<&'static str>

Optional human-facing machine description.

docs: Option<&'static str>

Optional longer-form source documentation from outer rustdoc comments.

states: Vec<CodebaseState>

States exported in source order.

transitions: Vec<CodebaseTransition>

Transition sites exported in deterministic order.

validator_entries: Vec<CodebaseValidatorEntry>

Declared validator-entry surfaces exported in deterministic order.

Implementations

impl CodebaseMachine

pub fn state(&self, index: usize) -> Option<&CodebaseState>

Returns one exported state by its stable state index.

pub fn state_named(&self, rust_name: &str) -> Option<&CodebaseState>

Returns one exported state by its Rust state name.

pub fn validator_entry(&self, index: usize) -> Option<&CodebaseValidatorEntry>

Returns one exported validator-entry surface by its stable machine-local index.

pub fn transition(&self, index: usize) -> Option<&CodebaseTransition>

Returns one exported transition site by its stable machine-local index.

pub fn node_id(&self, state_index: usize) -> String

Stable renderer node id for one state in this machine.

pub fn validator_node_id(&self, entry_index: usize) -> String

Stable renderer node id for one validator entry in this machine.

Trait Implementations

impl Clone for CodebaseMachine

fn clone(&self) -> CodebaseMachine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodebaseMachine

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

Formats the value using the given formatter.

impl PartialEq for CodebaseMachine

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CodebaseMachine

impl StructuralPartialEq for CodebaseMachine