Struct CodebaseState 

pub struct CodebaseState {
    pub index: usize,
    pub rust_name: &'static str,
    pub label: Option<&'static str>,
    pub description: Option<&'static str>,
    pub docs: Option<&'static str>,
    pub has_data: bool,
    pub direct_construction_available: bool,
    pub is_graph_root: bool,
}

One state in the codebase export surface.

Fields

index: usize

Stable machine-local state index.

rust_name: &'static str

Rust variant name emitted by Statum.

label: Option<&'static str>

Optional human-facing state label.

description: Option<&'static str>

Optional human-facing state description.

docs: Option<&'static str>

Optional longer-form source documentation from outer rustdoc comments.

has_data: bool

Whether the state carries state_data.

direct_construction_available: bool

Whether direct construction is available for this state.

is_graph_root: bool

Whether the state has no incoming transition in its machine.

Implementations

impl CodebaseState

pub fn display_label(&self) -> Cow<'static, str>

Human-facing state label used by text renderers.

Trait Implementations

impl Clone for CodebaseState

fn clone(&self) -> CodebaseState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodebaseState

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

Formats the value using the given formatter.

impl PartialEq for CodebaseState

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for CodebaseState

impl Eq for CodebaseState

impl StructuralPartialEq for CodebaseState