Skip to main content

Crate statum_core

Crate statum_core

Expand description

Core traits and helper types shared by Statum crates.

Most users reach these through the top-level statum crate. This crate holds the small runtime surface that macro-generated code targets:

state marker traits
transition capability traits
runtime error and result types
projection helpers for event-log style rebuilds

Modules§

projection: Event-stream projection helpers for Statum rebuild flows.

Structs§

Attested: A machine value with attached typed provenance for how it was produced.
LinkedMachineGraph: Erased machine graph emitted for codebase-level export over the linked build.
LinkedReferenceTypeDescriptor: One declared reference type carried by the linked build inventory.
LinkedRelationDescriptor: One exact machine relation carried by the linked build inventory.
LinkedStateDescriptor: Erased state descriptor carried by the linked machine inventory.
LinkedTransitionDescriptor: Erased transition descriptor carried by the linked machine inventory.
LinkedTransitionInventory: Runtime accessor for erased transition descriptors supplied by a distributed machine inventory.
LinkedValidatorEntryDescriptor: One declared validator-entry surface carried by the linked build inventory.
LinkedViaRouteDescriptor: One producer transition that can generate an attested route value.
MachineDescriptor: Rust-facing identity for a machine family.
MachineGraph: Structural machine graph emitted from macro-generated metadata.
MachinePresentation: Optional human-facing metadata layered on top of a machine graph.
MachinePresentationDescriptor: Optional machine-level presentation metadata.
MachineReferenceTarget: One exact target declared for a nominal machine reference type.
RebuildAttempt: One validator evaluation recorded during typed rehydration.
RebuildReport: A typed rehydration result plus the validator attempts that produced it.
RecordedTransition: A runtime record of one chosen transition.
Rejection: A structured validator rejection captured during typed rehydration.
StateDescriptor: Static descriptor for one generated state id.
StatePresentation: Optional state-level presentation metadata.
StaticMachineLinkDescriptor: One direct machine-like payload reference written in state data.
TransitionDescriptor: Static descriptor for one transition site.
TransitionInventory: Runtime accessor for transition descriptors that may be supplied by a distributed registration surface.
TransitionPresentation: Optional transition-level presentation metadata.
TransitionPresentationInventory: Runtime accessor for transition presentation metadata that may be supplied by a distributed registration surface.

Enums§

Branch: A first-class two-way branching transition result.
Error: Errors returned by Statum runtime helpers.
LinkedRelationBasis: Why one exact relation was inferred.
LinkedRelationKind: Exact relation kinds exported by the linked build.
LinkedRelationSource: One exact relation source exported by the linked build.
LinkedRelationTarget: Exact target written into one linked relation record.
MachineRole: Whether one machine family is a local protocol machine or a higher-level composition machine.

Traits§

CanTransitionMap: A machine that can transition by mapping its current state data into Next.
CanTransitionTo: A machine that can transition directly to Next.
CanTransitionWith: A machine that can transition using Data.
DataState: A generated state marker that carries payload data.
MachineIntrospection: Static introspection surface emitted for a generated Statum machine.
MachineReference: One nominal type that carries an exact machine relation declared once.
MachineStateIdentity: Identity for one concrete machine state.
MachineTransitionRecorder: Runtime recording helpers layered on top of static machine introspection.
StateMarker: A generated state marker type.
UnitState: A generated state marker with no payload.

Functions§

linked_machines: Returns every linked compiled machine family visible to the current build.
linked_reference_types: Returns every linked reference-type declaration visible to the current build.
linked_relations: Returns every linked exact relation record visible to the current build.
linked_validator_entries: Returns every linked compiled validator-entry surface visible to the current build.
linked_via_routes: Returns every linked attested transition route visible to the current build.

Type Aliases§

Result: Convenience result alias used by Statum APIs.
Validation: An opt-in validator result that carries structured rejection details.