Struct FlowGraph 

pub struct FlowGraph { /* private fields */ }

An immutable declaration of the M3 flow subset.

The worked example lives in the oxide-batch crate documentation, so that it keeps demonstrating the supported import path.

Implementations

impl FlowGraph

pub fn new(entry: NodeId) -> Self

Starts a graph at its entry node.

pub fn with_node(self, node: FlowNode) -> Self

Declares one node.

pub fn with_transition(self, transition: FlowTransition) -> Self

Declares one explicit transition.

pub fn with_sequence( self, source: NodeId, next: FlowTarget, ) -> Result<Self, PlanError>

Declares the convenience sequential edge.

A sequential edge compiles to an exact FAILED transition leading to TerminalKind::Fail and a less specific * transition leading to next. Custom successful exit codes therefore continue, while a failed step ends the job.

Errors

Returns PlanError::InvalidPattern only if the framework-owned patterns cannot be constructed.

pub fn compile( self, job_name: &JobName, revision: DefinitionRevision, ) -> Result<CompiledExecutionPlan, PlanError>

Validates and normalizes the graph into an immutable plan.

Errors

Returns PlanError for a missing entry node, a duplicate logical identifier, an undefined source or target, a node without outgoing transitions, two equally specific patterns that can match one value, an unreachable node, a cycle, an exceeded bound, or a manifest that cannot be encoded within the durable limit.

Trait Implementations

impl Clone for FlowGraph

fn clone(&self) -> FlowGraph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlowGraph

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

Formats the value using the given formatter.

impl Default for FlowGraph

fn default() -> FlowGraph

Returns the “default value” for a type.

impl Eq for FlowGraph

impl PartialEq for FlowGraph

fn eq(&self, other: &FlowGraph) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FlowGraph