Struct WorkflowInstance

pub struct WorkflowInstance {
    pub id: String,
    pub workflow_identifier: Identifier,
    pub state: Option<String>,
    pub data: Map<String, Value>,
    pub terminated: bool,
}

Workflow instance container.

TODO expand

Fields

id: String

Workflow instance ID. Unique among all workflow instances.

workflow_identifier: Identifier

Workflow identifier.

state: Option<String>

Name of current workflow state, or None if workflow has completed.

data: Map<String, Value>

Workflow data (a JSON object), passed between states.

If state is None, this is the final workflow output.

terminated: bool

Whether workflow has terminated prematurely.

Implementations

impl WorkflowInstance

pub fn for_definition( definition: &WorkflowDefinition, input: Option<Map<String, Value>>, ) -> Self

Generates a new workflow instance from a WorkflowDefinition.

The instance will have a new, randomly-generated id, will start at the workflow’s start state with the provided workflow input (or an empty JSON object if no initial input is provided).

pub fn for_workflow_identifier<I>( identifier: I, state: Option<String>, data: Option<Map<String, Value>>, ) -> Self

where I: Into<Identifier>,

Generates a new workflow instance for a workflow identified via its Identifier.

The instance will have a new, randomly-generated id, will point to the given state and contain the given data (or an empty JSON object if no data is provided).

Trait Implementations

impl Clone for WorkflowInstance

fn clone(&self) -> WorkflowInstance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowInstance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorkflowInstance

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WorkflowInstance

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

where __S: Serializer,

Serialize this value into the given Serde serializer.