Enum WorkflowState 

pub enum WorkflowState {
    Started,
    InProgress(String),
    Suspended(String),
    Completed,
    Failed(String),
}

Observable state of a workflow instance.

Returned via an Invocation from Engine::invoke. Callers observe state transitions or drop the handle for fire-and-forget execution.

Examples

use memable::WorkflowState;

let state = WorkflowState::InProgress("syncing records".into());
assert_eq!(state.to_string(), "in progress: syncing records");

Variants

Started

The workflow has been submitted but has not yet started executing.

InProgress(String)

The workflow is executing and has reported a status message.

Suspended(String)

The workflow is suspended, awaiting an external signal.

Completed

The workflow completed successfully.

Failed(String)

The workflow failed with an error message.

Implementations

impl WorkflowState

pub fn is_terminal(&self) -> bool

Returns true if this is a terminal state (Completed or Failed).

Examples

use memable::WorkflowState;

assert!(WorkflowState::Completed.is_terminal());
assert!(WorkflowState::Failed("err".into()).is_terminal());
assert!(!WorkflowState::Started.is_terminal());

pub fn message(&self) -> Option<&str>

Returns the message carried by this state, if any.

Started and Completed carry no message and return None. All other variants return the inner string.

Examples

use memable::WorkflowState;

let state = WorkflowState::InProgress("loading".into());
assert_eq!(state.message(), Some("loading"));

assert_eq!(WorkflowState::Completed.message(), None);

Trait Implementations

impl Clone for WorkflowState

fn clone(&self) -> WorkflowState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowState

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

Formats the value using the given formatter.

impl Display for WorkflowState

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

Formats the value using the given formatter.

impl PartialEq for WorkflowState

fn eq(&self, other: &WorkflowState) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for WorkflowState

impl StructuralPartialEq for WorkflowState