Struct FlowDefinition 

pub struct FlowDefinition {
    pub name: String,
    pub version: Option<String>,
    pub description: Option<String>,
    pub triggers: Vec<TriggerDefinition>,
    pub nodes: HashMap<String, NodeDefinition>,
    pub edges: Vec<EdgeDefinition>,
    pub settings: FlowSettings,
}

A complete flow definition from YAML.

This is the top-level structure representing a XERV flow document.

Example

name: order_processing
version: "1.0"
description: Process incoming orders with fraud detection

triggers:
  - id: api_webhook
    type: webhook
    params:
      port: 8080
      path: /orders

nodes:
  validate:
    type: std::json_parse
    config:
      strict: true

  fraud_check:
    type: std::switch
    config:
      condition:
        type: greater_than
        field: risk_score
        value: 0.8

  process_order:
    type: plugins::order_processor

  flag_fraud:
    type: plugins::fraud_handler

edges:
  - from: api_webhook
    to: validate
  - from: validate
    to: fraud_check
  - from: fraud_check.true
    to: flag_fraud
  - from: fraud_check.false
    to: process_order

settings:
  max_concurrent_executions: 100
  execution_timeout_ms: 30000

Fields

name: String

Flow name (required).

version: Option<String>

Flow version (optional, defaults to “1.0”).

description: Option<String>

Human-readable description.

triggers: Vec<TriggerDefinition>

Triggers that start this flow.

nodes: HashMap<String, NodeDefinition>

Nodes in the flow, keyed by node ID.

edges: Vec<EdgeDefinition>

Edges connecting nodes.

settings: FlowSettings

Runtime settings.

Implementations

impl FlowDefinition

pub fn new(name: impl Into<String>) -> Self

Create a new flow definition.

pub fn from_yaml(yaml: &str) -> Result<Self, Error>

Parse a flow definition from YAML string.

pub fn from_file(path: &Path) -> Result<Self, FlowLoadError>

Parse a flow definition from YAML file.

pub fn to_yaml(&self) -> Result<String, Error>

Serialize to YAML string.

pub fn validate(&self) -> ValidationResult

Validate the flow definition.

pub fn from_yaml_validated(yaml: &str) -> Result<Self, FlowLoadError>

Parse and validate in one step.

pub fn with_version(self, version: impl Into<String>) -> Self

Set version.

pub fn with_description(self, desc: impl Into<String>) -> Self

Set description.

pub fn with_trigger(self, trigger: TriggerDefinition) -> Self

Add a trigger.

pub fn with_node(self, id: impl Into<String>, node: NodeDefinition) -> Self

Add a node.

pub fn with_edge(self, edge: EdgeDefinition) -> Self

Add an edge.

pub fn with_settings(self, settings: FlowSettings) -> Self

Set settings.

pub fn effective_version(&self) -> &str

Get the effective version (defaults to “1.0”).

pub fn node_ids(&self) -> impl Iterator<Item = &str>

Get all node IDs.

pub fn trigger_ids(&self) -> impl Iterator<Item = &str>

Get all trigger IDs.

pub fn get_node(&self, id: &str) -> Option<&NodeDefinition>

Get a node by ID.

pub fn get_trigger(&self, id: &str) -> Option<&TriggerDefinition>

Get a trigger by ID.

pub fn has_trigger(&self, id: &str) -> bool

Check if a trigger with the given ID exists.

pub fn has_node(&self, id: &str) -> bool

Check if a node with the given ID exists.

pub fn enabled_triggers(&self) -> impl Iterator<Item = &TriggerDefinition>

Get enabled triggers.

pub fn enabled_nodes(&self) -> impl Iterator<Item = (&str, &NodeDefinition)>

Get enabled nodes.

pub fn edges_from(&self, node_id: &str) -> impl Iterator<Item = &EdgeDefinition>

Find edges from a given node.

pub fn edges_to(&self, node_id: &str) -> impl Iterator<Item = &EdgeDefinition>

Find edges to a given node.

Trait Implementations

impl Clone for FlowDefinition

fn clone(&self) -> FlowDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlowDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FlowDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FlowDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.