Struct CodebaseDoc 

pub struct CodebaseDoc { /* private fields */ }

Stable export model for the linked compiled machine inventory.

Implementations

impl CodebaseDoc

pub fn linked() -> Result<Self, CodebaseDocError>

Builds a combined codebase document from every linked machine visible to the current build.

pub fn try_from_linked( linked: &'static [LinkedMachineGraph], ) -> Result<Self, CodebaseDocError>

Builds a combined codebase document from an explicit linked machine inventory.

pub fn try_from_linked_with_validator_entries( linked: &'static [LinkedMachineGraph], validator_entries: &'static [LinkedValidatorEntryDescriptor], ) -> Result<Self, CodebaseDocError>

Builds a combined codebase document from explicit linked machine and validator-entry inventories.

pub fn machines(&self) -> &[CodebaseMachine]

Exported machines in stable codebase order.

pub fn links(&self) -> &[CodebaseLink]

Resolved static cross-machine links in stable order.

pub fn relations(&self) -> &[CodebaseRelation]

Resolved exact static relations in stable order.

pub fn machine(&self, index: usize) -> Option<&CodebaseMachine>

Returns one exported machine by its stable codebase index.

pub fn relation(&self, index: usize) -> Option<&CodebaseRelation>

Returns one exported relation by its stable codebase index.

pub fn machine_relation_groups(&self) -> &[CodebaseMachineRelationGroup]

Groups exact relations by source and target machine for renderer and inspector use.

pub fn composition_relation_groups(&self) -> Vec<CodebaseMachineRelationGroup>

Groups exact relations that are owned by composition machines.

pub fn outbound_relations_for_machine( &self, machine_index: usize, ) -> impl Iterator<Item = &CodebaseRelation> + '_

Exact relations whose source belongs to machine_index.

pub fn inbound_relations_for_machine( &self, machine_index: usize, ) -> impl Iterator<Item = &CodebaseRelation> + '_

Exact relations whose target belongs to machine_index.

pub fn outbound_relations_for_state( &self, machine_index: usize, state_index: usize, ) -> impl Iterator<Item = &CodebaseRelation> + '_

Exact relations whose source belongs to one exported state.

pub fn inbound_relations_for_state( &self, machine_index: usize, state_index: usize, ) -> impl Iterator<Item = &CodebaseRelation> + '_

Exact relations whose target belongs to one exported state.

pub fn outbound_relations_for_transition( &self, machine_index: usize, transition_index: usize, ) -> impl Iterator<Item = &CodebaseRelation> + '_

Exact relations whose source belongs to one exported transition site.

pub fn inbound_relations_for_transition( &self, machine_index: usize, transition_index: usize, ) -> impl Iterator<Item = &CodebaseRelation> + '_

Exact relations whose target belongs to one exported transition site.

The current exact relation surface never targets transitions, so this iterator is always empty. It exists so the inspector can use the same navigation API shape for machines, states, and transitions.

pub fn relation_detail( &self, index: usize, ) -> Option<CodebaseRelationDetail<'_>>

Resolves one exact relation into typed source and target references for downstream consumers such as the inspector TUI.

Trait Implementations

impl Clone for CodebaseDoc

fn clone(&self) -> CodebaseDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodebaseDoc

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

Formats the value using the given formatter.

impl PartialEq for CodebaseDoc

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

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 CodebaseDoc

impl StructuralPartialEq for CodebaseDoc