Skip to main content

FlowInstance

backbone_core::flow

Struct FlowInstance 

Source 
pub struct FlowInstance<S>
where
    S: Debug + Clone + Serialize + DeserializeOwned,
{
    pub id: String,
    pub status: FlowStatus,
    pub current_step: Option<S>,
    pub context: Value,
    pub completed_steps: Vec<S>,
    pub error: Option<String>,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
}
👎Deprecated since 3.16.0:

nothing used it; declared workflows run through backbone_core::workflow (WorkflowSpec, WorkflowDefinition and WorkflowEngine)

Expand description

Generic workflow instance parametrised over the step enum S.

Generated files use a type alias: pub type OrderProcessingFlowInstance = FlowInstance<OrderProcessingFlowStep>;

Fields§

§id: String
👎Deprecated since 3.16.0:

nothing used it; declared workflows run through backbone_core::workflow (WorkflowSpec, WorkflowDefinition and WorkflowEngine)

§status: FlowStatus
👎Deprecated since 3.16.0:

nothing used it; declared workflows run through backbone_core::workflow (WorkflowSpec, WorkflowDefinition and WorkflowEngine)

§current_step: Option<S>
👎Deprecated since 3.16.0:

nothing used it; declared workflows run through backbone_core::workflow (WorkflowSpec, WorkflowDefinition and WorkflowEngine)

§context: Value
👎Deprecated since 3.16.0:

nothing used it; declared workflows run through backbone_core::workflow (WorkflowSpec, WorkflowDefinition and WorkflowEngine)

§completed_steps: Vec<S>
👎Deprecated since 3.16.0:

nothing used it; declared workflows run through backbone_core::workflow (WorkflowSpec, WorkflowDefinition and WorkflowEngine)

§error: Option<String>
👎Deprecated since 3.16.0:

nothing used it; declared workflows run through backbone_core::workflow (WorkflowSpec, WorkflowDefinition and WorkflowEngine)

§created_at: DateTime<Utc>
👎Deprecated since 3.16.0:

nothing used it; declared workflows run through backbone_core::workflow (WorkflowSpec, WorkflowDefinition and WorkflowEngine)

§updated_at: DateTime<Utc>
👎Deprecated since 3.16.0:

nothing used it; declared workflows run through backbone_core::workflow (WorkflowSpec, WorkflowDefinition and WorkflowEngine)

Implementations§

Source§

impl<S> FlowInstance<S>
where S: Debug + Clone + Serialize + DeserializeOwned,

Source

pub fn new(id: impl Into<String>) -> Self

Source

pub fn is_complete(&self) -> bool

Source

pub fn is_running(&self) -> bool

Source

pub fn set_context(&mut self, key: &str, value: Value)

Source

pub fn get_context(&self, key: &str) -> Option<&Value>

Trait Implementations§

Source§

impl<S> Clone for FlowInstance<S>
where S: Debug + Clone + Serialize + DeserializeOwned + Clone,

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<S> Debug for FlowInstance<S>
where S: Debug + Clone + Serialize + DeserializeOwned + Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de, S> Deserialize<'de> for FlowInstance<S>
where S: Debug + Clone + Serialize + DeserializeOwned,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<S> Serialize for FlowInstance<S>
where S: Debug + Clone + Serialize + DeserializeOwned,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<S> WorkflowContext<FlowInstance<S>> for FlowInstance<S>
where S: Debug + Clone + Serialize + DeserializeOwned + Send + Sync,

Source§

fn entity(&self) -> &FlowInstance<S>

👎Deprecated since 3.16.0:

nothing used it; declared workflows run through backbone_core::workflow (WorkflowSpec, WorkflowDefinition and WorkflowEngine)

Source§

fn set_var(&mut self, key: &str, value: Value)

👎Deprecated since 3.16.0:

nothing used it; declared workflows run through backbone_core::workflow (WorkflowSpec, WorkflowDefinition and WorkflowEngine)

Source§

fn get_var(&self, key: &str) -> Option<&Value>

👎Deprecated since 3.16.0:

nothing used it; declared workflows run through backbone_core::workflow (WorkflowSpec, WorkflowDefinition and WorkflowEngine)

Auto Trait Implementations§

§

impl<S> Freeze for FlowInstance<S>
where Option<S>: Freeze, Vec<S>: Freeze,

§

impl<S> RefUnwindSafe for FlowInstance<S>
where Option<S>: RefUnwindSafe, Vec<S>: RefUnwindSafe,

§

impl<S> Send for FlowInstance<S>
where Option<S>: Send, Vec<S>: Send,

§

impl<S> Sync for FlowInstance<S>
where Option<S>: Sync, Vec<S>: Sync,

§

impl<S> Unpin for FlowInstance<S>
where Option<S>: Unpin, Vec<S>: Unpin,

§

impl<S> UnsafeUnpin for FlowInstance<S>
where Option<S>: UnsafeUnpin, Vec<S>: UnsafeUnpin,

§

impl<S> UnwindSafe for FlowInstance<S>
where Option<S>: UnwindSafe, Vec<S>: 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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<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