Skip to main content

FlowExecutor

Struct FlowExecutor 

Source
pub struct FlowExecutor<H> {
    pub handler: Arc<H>,
}
Expand description

Generic executor shell — holds the handler, provides cancel/fail helpers.

Generated files wrap this with a newtype and add the unique execute_step():

ⓘ
pub struct OrderProcessingFlowExecutor<H: OrderProcessingStepHandler>(FlowExecutor<H>);

impl<H: OrderProcessingStepHandler> OrderProcessingFlowExecutor<H> {
    pub fn new(handler: Arc<H>) -> Self { Self(FlowExecutor::new(handler)) }
    pub fn handler(&self) -> &Arc<H> { &self.0.handler }

    pub async fn execute_step(&self, instance: &mut OrderProcessingFlowInstance)
        -> Result<(), FlowError> { /* unique dispatch */ }

    pub async fn start(&self, id: impl Into<String>)
        -> Result<OrderProcessingFlowInstance, FlowError> { self.0.start(id) }

    pub async fn run(&self, instance: &mut OrderProcessingFlowInstance)
        -> Result<(), FlowError> {
        while !instance.is_complete() && instance.status != FlowStatus::Waiting {
            self.execute_step(instance).await?;
        }
        Ok(())
    }

    pub fn cancel(&self, instance: &mut OrderProcessingFlowInstance) {
        self.0.cancel(instance);
    }
    pub fn fail(&self, instance: &mut OrderProcessingFlowInstance, error: impl Into<String>) {
        self.0.fail(instance, error);
    }
}

Fields§

§handler: Arc<H>

Implementations§

Source§

impl<H: Send + Sync + 'static> FlowExecutor<H>

Source

pub fn new(handler: Arc<H>) -> Self

Source

pub fn start<S>(&self, id: impl Into<String>, first_step: S) -> FlowInstance<S>

Start a new flow instance at a given step.

Source

pub fn cancel<S>(&self, instance: &mut FlowInstance<S>)

Cancel the flow instance.

Source

pub fn fail<S>(&self, instance: &mut FlowInstance<S>, error: impl Into<String>)

Mark the flow instance as failed with a message.

Auto Trait Implementations§

§

impl<H> Freeze for FlowExecutor<H>
where Arc<H>: Freeze,

§

impl<H> RefUnwindSafe for FlowExecutor<H>
where Arc<H>: RefUnwindSafe,

§

impl<H> Send for FlowExecutor<H>
where Arc<H>: Send,

§

impl<H> Sync for FlowExecutor<H>
where Arc<H>: Sync,

§

impl<H> Unpin for FlowExecutor<H>
where Arc<H>: Unpin,

§

impl<H> UnsafeUnpin for FlowExecutor<H>
where Arc<H>: UnsafeUnpin,

§

impl<H> UnwindSafe for FlowExecutor<H>
where Arc<H>: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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