Skip to main content

WorkflowExecutor

Struct WorkflowExecutor 

Source
pub struct WorkflowExecutor { /* private fields */ }
Expand description

An Executor that runs a child Workflow, enabling hierarchical composition.

Implementations§

Source§

impl WorkflowExecutor

Source

pub fn new(id: impl Into<String>, workflow: Workflow) -> WorkflowExecutor

Wrap workflow as an executor with the given id.

By default the child’s outputs are sent onward as messages from this node. Use WorkflowExecutor::with_direct_output to instead yield them directly as parent workflow outputs.

Source

pub fn with_direct_output(self, allow: bool) -> WorkflowExecutor

Yield the child’s outputs directly to the parent’s output stream instead of forwarding them as messages.

Source

pub fn workflow(&self) -> &Workflow

The wrapped child workflow.

Trait Implementations§

Source§

impl Executor for WorkflowExecutor

Source§

fn id(&self) -> &str

A unique id for this executor within the workflow.
Source§

fn execute<'life0, 'async_trait>( &'life0 self, message: Value, ctx: WorkflowContext, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, WorkflowExecutor: 'async_trait,

Handle an incoming message.
Source§

fn snapshot_state<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Option<Value>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Capture serializable state for checkpointing. Read more
Source§

fn restore_state<'life0, 'async_trait>( &'life0 self, _state: Value, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Restore state previously produced by Executor::snapshot_state. Read more
Source§

fn reset<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Reset per-run state before a fresh run (upstream IResettableExecutor): an executor instance is shared by every run of its workflow, so one that keeps per-run state clears it here. Called on every executor at the start of a run (not on a resume from a checkpoint). The default does nothing.
Source§

fn describe_protocol(&self) -> ProtocolDescriptor

The message types this executor accepts, sends and yields (upstream DescribeProtocol). Payloads here are JSON, so types are names the workflow’s author chooses (or JSON type names). The default accepts anything and declares nothing.
Source§

fn request_port(&self) -> Option<RequestPortInfo>

For a request port (a node that hands requests to the caller), its request and response type names; None for other executors.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more