Struct SubgraphNode 

pub struct SubgraphNode { /* private fields */ }

One graph running as a node of another.

See the module documentation for the channel rules.

Implementations

impl SubgraphNode

pub fn new(name: impl Into<String>, graph: Arc<CompiledGraph>) -> Self

Wraps a compiled graph as a node.

Channels the two schemas declare under the same name pass through in both directions. Add Self::with_input or Self::with_output for channels whose names differ, or call Self::isolated to pass nothing implicitly.

pub fn with_input( self, parent: impl Into<String>, child: impl Into<String>, ) -> Self

Feeds a parent channel into a subgraph channel under a different name.

pub fn with_output( self, child: impl Into<String>, parent: impl Into<String>, ) -> Self

Writes a subgraph channel back to a parent channel under a different name.

pub fn isolated(self) -> Self

Exchanges only the channels named by with_input and with_output.

Without this, a channel both schemas declare under the same name passes through. Isolating is worth the extra naming when the two graphs are maintained apart, because then adding a channel to one cannot silently start feeding the other.

pub fn graph(&self) -> &Arc<CompiledGraph>

The graph this node runs.

Trait Implementations

impl Node for SubgraphNode

fn validate_against(&self, parent: &StateSchema) -> Result<()>

Rejects a mapping that names a channel the relevant side does not declare.

This runs when the parent compiles, so a mismatch never reaches a run.

fn name(&self) -> &str

Node identifier

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 NodeContext, ) -> Pin<Box<dyn Future<Output = Result<NodeOutput>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute the node and return state updates

fn validate(&self) -> Result<()>

fn execute_stream<'a>( &'a self, ctx: &'a NodeContext, ) -> Pin<Box<dyn Stream<Item = Result<StreamEvent>> + Send + 'a>>

Streams execution events for this node.