Struct WorkflowDef 

#[non_exhaustive]
pub struct WorkflowDef { /* private fields */ }

A workflow definition: a condition and a tree of steps.

Only parse makes one, and nothing changes one after: every field is read through its accessor, so a definition a compiler sees has passed every rule parse checks, and the interpreter can trust them.

use dataflow_rs::def::{ParseOptions, StepDef, parse};
use serde_json::json;

let json = json!({"id": "w", "priority": 5, "tasks": [
    {"id": "t", "function": {"name": "log", "input": {"message": "hi"}}}
]});
let def = parse(&json, ParseOptions::default()).def.unwrap();
assert_eq!((def.id(), def.priority()), ("w", 5));
let StepDef::Task(task) = &def.tasks()[0] else { unreachable!() };
assert_eq!(task.function().name(), "log");

A field cannot be assigned:

let json = json!({"id": "w", "tasks": []});
let mut def = parse(&json, ParseOptions::default()).def.unwrap();
def.priority = 5;

Implementations

impl WorkflowDef

pub fn id(&self) -> &str

The workflow’s id: a non-empty string.

pub fn header(&self) -> &NodeHeader

The name, description and ext.

pub fn priority(&self) -> u32

The run order: lower runs first, and equal priorities keep their order. Default 0.

pub fn condition(&self) -> Option<&Logic>

Whether a message enters the workflow. Absent means true.

pub fn tasks(&self) -> &[StepDef]

The steps, as authored: tasks and groups.

pub fn on_failure(&self) -> WorkflowFailurePolicy

What a task’s failure that reaches the workflow does. Default fail.

pub fn channel(&self) -> &str

The routing channel. Default "default", as in v3.

pub fn status(&self) -> Status

The lifecycle status. Default active.

pub fn version(&self) -> u32

The definition’s version. Default 1.

pub fn rollout(&self) -> Option<&Rollout>

The workflow’s slice of the traffic on its channel. None runs for every message.

pub fn loop(&self) -> Option<&LoopDef>

The bounded loop over the task list, if any.

pub fn tags(&self) -> &[String]

Tags for the host’s filtering.

pub fn created_at(&self) -> Option<DateTime<Utc>>

When the definition was created. Kept for stored definitions, never read.

pub fn updated_at(&self) -> Option<DateTime<Utc>>

When the definition was last updated. Kept, never read.

pub fn walk(&self) -> impl Iterator<Item = (AuthoredPath, StepKind, &StepDef)>

Every step with its authored path and kind, pre-order: loop.setup first, then tasks, each group before its members.

A task’s kind is StepKind::Task and a group’s StepKind::Group; every step under loop.setup, group or task, is StepKind::Setup.

Trait Implementations

impl Clone for WorkflowDef

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 WorkflowDef

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

Formats the value using the given formatter.

impl PartialEq for WorkflowDef

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for WorkflowDef

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WorkflowDef