Struct Workflow

pub struct Workflow {
    pub id: String,
    pub start: Elem,
    pub user: User,
    pub metadata: Vec<Metadata>,
    pub signature: String,
}

Defines the workflow’s toplevel view.

Fields

id: String

The identifier of this workflow as a whole.

start: Elem

Defines the first node in the workflow.

user: User

The user instigating this workflow (and getting the result, if any).

metadata: Vec<Metadata>

The metadata associated with this workflow as a whole.

signature: String

The signature verifying this workflow.

Implementations

impl Workflow

pub fn to_eflint(&self) -> Vec<Phrase>

Compiles the Workflow to a series of eFLINT phrases.

Note that this only creates references to datasets, functions and users; any definition of them needs to be added separately.

Returns

A series of eFLINT statements that represent this Workflow.

impl Workflow

pub fn optimize(&mut self)

Optimizes the workflow graph by pruning elements which do task-independent things (like branching without tasks) and aggregates aggregatable edges.

impl Workflow

pub fn visualize(&self) -> WorkflowFormatter<'_>

Returns a nice formatter that visualizes the workflow more easily understandable than its Debug-implementation.

Returns

A new WorkflowFormatter that can visualize the workflow when its Display-implementation is called.

Trait Implementations

impl Clone for Workflow

fn clone(&self) -> Workflow

Returns a copy 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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Workflow

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Workflow> for Workflow

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Workflow) -> Result<Self, Self::Error>

Performs the conversion.