Struct WorkflowSpec 

pub struct WorkflowSpec {
    pub name: String,
    pub version: i32,
    pub trigger_event: String,
    pub extract: Vec<(String, Expr)>,
    pub context: Vec<(String, Value)>,
    pub persistence: bool,
    pub timeout: Option<Dur>,
    pub retry: Option<RetrySpec>,
    pub steps: Vec<StepSpec>,
    pub compensation: Vec<CompStep>,
}

The compiled workflow.

Fields

name: String

Its name (PasswordReset).

version: i32

Its version, from the file.

trigger_event: String

The event that starts an instance.

extract: Vec<(String, Expr)>

Context keys filled from the start event: company_id: event.company_id.

context: Vec<(String, Value)>

The context an instance starts with, before extract.

persistence: bool

false runs the whole flow in one transaction and allows no wait.

timeout: Option<Dur>

How long an instance may live; passing it while waiting ends it expired.

retry: Option<RetrySpec>

The workflow-wide retry policy.

steps: Vec<StepSpec>

The first step is the first of these.

compensation: Vec<CompStep>

Compensation, in declaration order; it runs in reverse.

Implementations

impl WorkflowSpec

pub fn from_json(text: &str) -> Self

Read the JSON a generated module carries.

Panics

When the text is not a spec: the generator wrote it, so that is a bug of the generator or a version mismatch between it and this crate, and it is loudest at startup.

pub fn step(&self, name: &str) -> Option<&StepSpec>

The step called name.

pub fn events(&self) -> Vec<&str>

The events this workflow reacts to: its trigger and every event a wait names.

Trait Implementations

impl Clone for WorkflowSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorkflowSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WorkflowSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for WorkflowSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WorkflowSpec