Enum WorkflowState 

pub enum WorkflowState {
    Started,
    InProgress(String),
    Suspended {
        key: String,
        status: String,
    },
    Completed(Option<String>),
    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

The workflow is suspended, awaiting an external signal.

key is the step key where the workflow suspended (e.g. "approval:v1"). status is the human-readable message set via SuspendBuilder::status, or the key itself if no custom status was provided.

Fields

key: String

The step key identifying this suspend point.

status: String

Human-readable status message.

Completed(Option<String>)

The workflow completed successfully.

Contains the last status message set via Context::set_status before the workflow returned, or None if no status was ever set.

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(None).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 carries no message.

Examples

use memable::WorkflowState;

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

assert_eq!(WorkflowState::Completed(None).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