Struct FlowRef 

pub struct FlowRef(/* private fields */);

A wrapper around Arc<Flow> to support poem-openapi traits.

This wrapper exists to work around Rust’s orphan rules which prevent implementing external traits on external types like Arc<Flow>.

Implementations

impl FlowRef

pub fn new(flow: Flow) -> Self

Create a new FlowRef from a Flow.

pub fn from_arc(arc: Arc<Flow>) -> Self

Create a new FlowRef from an Arc<Flow>.

pub fn as_flow(&self) -> &Flow

Get a reference to the underlying Flow.

pub fn into_arc(self) -> Arc<Flow>

Get the underlying Arc<Flow>.

pub fn as_arc(&self) -> &Arc<Flow>

Get a reference to the underlying Arc<Flow>.

Methods from Deref<Target = Flow>

pub fn slow_clone(&self) -> Self

Create a clone of this flow.

Warning: This method performs a deep clone of the entire workflow structure, including all steps, metadata, and configurations. This can be expensive for large workflows.

Performance

• Cloning large workflows with many steps can be slow
• Consider using Arc<Flow> for shared ownership instead
• Only use this when you need to modify the workflow structure

Example

use stepflow_core::workflow::Flow;

let original_flow = Flow::default();
let cloned_flow = original_flow.slow_clone();

pub fn name(&self) -> Option<&str>

pub fn description(&self) -> Option<&str>

pub fn version(&self) -> Option<&str>

pub fn metadata(&self) -> &HashMap<String, Value>

pub fn steps(&self) -> &[Step]

Returns a reference to all steps in the flow.

pub fn examples(&self) -> &[ExampleInput]

pub fn variables(&self) -> Option<VariableSchema>

Get the variable schema for the flow.

This constructs a VariableSchema from the schema definition, extracting runtime metadata like defaults, secrets, and required variables.

pub fn variable_schema(&self) -> Option<&SchemaRef>

Get a reference to the variable schema (raw SchemaRef).

pub fn step(&self, index: usize) -> &Step

Returns a reference to the step at the given index.

Panics

Panics if the index is out of bounds.

pub fn output(&self) -> &ValueExpr

Returns a reference to the flow’s output value.

pub fn test(&self) -> Option<&TestConfig>

pub fn schemas(&self) -> &FlowSchema

Get the flow’s schema information.

pub fn input_schema(&self) -> Option<&SchemaRef>

Get the flow’s input schema.

pub fn output_schema(&self) -> Option<&SchemaRef>

Get the flow’s output schema.

pub fn step_output_schema(&self, step_id: &str) -> Option<&SchemaRef>

Get the output schema for a specific step.

pub fn get_all_examples(&self) -> Vec<ExampleInput>

Get all example inputs, including those derived from test cases.

Trait Implementations

impl Clone for FlowRef

fn clone(&self) -> FlowRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlowRef

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

Formats the value using the given formatter.

impl Deref for FlowRef

type Target = Flow

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for FlowRef

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Arc<Flow>> for FlowRef

fn from(arc: Arc<Flow>) -> Self

Converts to this type from the input type.

impl From<Flow> for FlowRef

fn from(flow: Flow) -> Self

Converts to this type from the input type.

impl PartialEq for FlowRef

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FlowRef