Skip to main content

WorkflowHost

Struct WorkflowHost 

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

A parsed, validated and compiled workflow. Assembly is the only constructor, so a long-running host cannot accidentally skip static validation.

Implementations§

Source§

impl WorkflowHost

Source

pub fn assemble( spec_json: &str, registry: &NodeRegistry, ) -> Result<Self, HostError>

Parse, validate and compile a spec from JSON.

Source

pub fn from_spec( spec: &Spec, registry: &NodeRegistry, ) -> Result<Self, HostError>

Validate and compile every branch of spec.

Source

pub fn spec_id(&self) -> &str

Spec id.

Source

pub fn branch_id(&self) -> &str

Id of the first (root) branch.

Source

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

Every branch id.

Source

pub fn branch_count(&self) -> usize

Number of branches.

Source

pub fn context(&self, state: Arc<dyn State>) -> WorkflowContext

Context for the root branch over state.

Source

pub fn context_for( &self, branch_id: &str, state: Arc<dyn State>, ) -> WorkflowContext

Context for branch_id over state.

Source

pub async fn run_event( &self, ctx: &WorkflowContext, event: Event, ) -> Option<RunOutcome>

Drive one event through the context’s branch.

Source

pub async fn run_event_on( &self, branch_id: &str, ctx: &WorkflowContext, event: Event, ) -> Option<RunOutcome>

Drive one event through branch_id; None when the branch does not exist.

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, 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