Struct MachineDoc 

pub struct MachineDoc<S: 'static, T: 'static> { /* private fields */ }

Static machine graph exported directly from MachineIntrospection::GRAPH.

This type is authoritative only for machine-local topology: states, transition sites, exact legal targets, and graph roots derivable from the static graph itself.

Implementations

impl<S, T> MachineDoc<S, T>

where S: Eq,

pub fn export(&self) -> ExportDoc

Builds the canonical stable export model without presentation metadata.

impl<S, T> MachineDoc<S, T>

where S: Copy + Eq + 'static, T: Copy + Eq + 'static,

pub fn export_with_presentation<MachineMeta, StateMeta, TransitionMeta>( &self, presentation: &MachinePresentation<S, T, MachineMeta, StateMeta, TransitionMeta>, ) -> Result<ExportDoc, ExportDocError>

Builds the canonical stable export model and joins matching labels and descriptions from a presentation overlay.

impl<S, T> MachineDoc<S, T>

pub fn machine(&self) -> MachineDescriptor

Descriptor for the exported machine family.

pub fn states(&self) -> &[StateDoc<S>]

Exported states in the same order as the underlying static graph.

pub fn edges(&self) -> &[EdgeDoc<S, T>]

Exported transition sites sorted stably for deterministic renderers.

impl<S, T> MachineDoc<S, T>

where S: Copy + Eq + 'static,

pub fn state(&self, id: S) -> Option<&StateDoc<S>>

Returns the exported state descriptor for one generated state id.

impl<S, T> MachineDoc<S, T>

pub fn roots(&self) -> impl Iterator<Item = &StateDoc<S>>

Returns every state with no incoming edge in the exported topology.

impl<S, T> MachineDoc<S, T>

where S: Copy + Eq + Hash + 'static, T: Copy + Eq + 'static,

pub fn from_machine<M>() -> Self

where M: MachineIntrospection<StateId = S, TransitionId = T>,

Exports one machine family from a concrete MachineIntrospection type.

This is the normal entry point when the graph comes from Statum itself. It will panic only if Statum emitted an invalid MachineIntrospection::GRAPH.

pub fn try_from_graph( graph: &'static MachineGraph<S, T>, ) -> Result<Self, MachineDocError>

Exports one externally supplied machine graph after validating it.

Use this when the graph does not come from a concrete Statum machine type and you want malformed external graphs to fail closed with MachineDocError instead of being rendered best-effort.

Trait Implementations

impl<S: Clone + 'static, T: Clone + 'static> Clone for MachineDoc<S, T>

fn clone(&self) -> MachineDoc<S, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + 'static, T: Debug + 'static> Debug for MachineDoc<S, T>

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

Formats the value using the given formatter.

impl<S, T> ExportSource for MachineDoc<S, T>

where S: Eq,

fn export_doc(&self) -> Cow<'_, ExportDoc>

impl<S, T> From<&MachineDoc<S, T>> for ExportDoc

where S: Eq,

fn from(doc: &MachineDoc<S, T>) -> Self

Converts to this type from the input type.

impl<S: PartialEq + 'static, T: PartialEq + 'static> PartialEq for MachineDoc<S, T>

fn eq(&self, other: &MachineDoc<S, T>) -> 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<S, T> TryFrom<&'static MachineGraph<S, T>> for MachineDoc<S, T>

where S: Copy + Eq + Hash + 'static, T: Copy + Eq + 'static,

type Error = MachineDocError

The type returned in the event of a conversion error.

fn try_from(graph: &'static MachineGraph<S, T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<S: Eq + 'static, T: Eq + 'static> Eq for MachineDoc<S, T>

impl<S: 'static, T: 'static> StructuralPartialEq for MachineDoc<S, T>