Struct Workflow 

pub struct Workflow {

    pub run: Option<RunMachine>,
    pub verbs: BTreeMap<String, Vec<Transition>>,
    pub derived: BTreeMap<String, Expr>,
    pub relations: BTreeMap<String, Value>,
    pub flags: BTreeMap<String, Value>,
    pub stored_as: Vec<StorageRule>,
    pub losses: Vec<String>,
    pub description: Option<String>,
    pub params: Map<String, Value>,
    pub roles: BTreeMap<String, Expr>,
    pub initial: Vec<Transition>,
    pub statuses: BTreeMap<String, Status>,
    pub on: BTreeMap<String, Vec<Transition>>,
    pub dispatch: Dispatch,
    pub notify: BTreeMap<String, BTreeMap<String, String>>,
}

A board’s workflow.

Fields

run: Option<RunMachine>

The run machine; absent for legacy homes during migration.

verbs: BTreeMap<String, Vec<Transition>>

Card verbs declared once, with source statuses on each transition.

derived: BTreeMap<String, Expr>

Derived card conditions, such as ready.

relations: BTreeMap<String, Value>

Relation policies, interpreted by the engine’s relation primitives.

flags: BTreeMap<String, Value>

Flag policies, interpreted by the engine’s flag primitives.

stored_as: Vec<StorageRule>

Ordered Hermes projection and its explicitly accepted losses.

losses: Vec<String>

description: Option<String>

What a person reads about it.

params: Map<String, Value>

Named values the expressions read (params.failure_limit); a home’s config.yaml kanban: keys override them by name, so Hermes’s settings are this workflow’s parameters.

roles: BTreeMap<String, Expr>

Who acts on a card, each an expression naming a profile (implementer: card.assignee) or a person.

initial: Vec<Transition>

Where a new card starts: the first transition whose guard holds.

statuses: BTreeMap<String, Status>

Every status, by name.

on: BTreeMap<String, Vec<Transition>>

Events that apply in every status (a status’s own on for the same event is tried first).

dispatch: Dispatch

The dispatcher.

notify: BTreeMap<String, BTreeMap<String, String>>

Who is told what: for each audience (creator, worker, dependency, chat: who a card’s subscriptions are), the event kinds it hears and the template each is told in. A kind not named is not sent.

Implementations

impl Workflow

pub fn check(&self) -> Result<(), String>

Every name a transition targets or a run names must be declared; answers what is not.

Trait Implementations

impl Clone for Workflow

fn clone(&self) -> Workflow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Workflow

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Workflow

fn deserialize<__D>( __deserializer: __D, ) -> Result<Workflow, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Workflow

impl JsonSchema for Workflow

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Workflow

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Workflow

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Workflow