Skip to main content

Workflow

Struct Workflow 

Source
pub struct Workflow {
    pub version: String,
    pub name: Option<String>,
    pub description: Option<String>,
    pub env: Vec<VariableDecl>,
    pub conversation: Vec<VariableDecl>,
    pub graph: GraphDoc,
}
Expand description

A complete workflow document.

Fields§

§version: String

Document format version.

§name: Option<String>§description: Option<String>§env: Vec<VariableDecl>

Environment variables (env.*). Values may be omitted and supplied by the host at run time.

§conversation: Vec<VariableDecl>

Conversation variables (conversation.*), persisted by the host between runs.

§graph: GraphDoc

Implementations§

Source§

impl Workflow

Source

pub fn from_json(text: &str) -> Result<Self, DocumentError>

Parse a JSON document.

Source

pub fn from_yaml(text: &str) -> Result<Self, DocumentError>

Parse a YAML document.

Source

pub fn parse(text: &str) -> Result<Self, DocumentError>

Parse JSON or YAML, detecting the format from the first non-blank character.

Source

pub fn from_value(raw: Value) -> Result<Self, DocumentError>

Build from an already-decoded JSON value.

Source§

impl Workflow

Source

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

Serialize to JSON in the same layout Workflow::from_json accepts.

Source

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

Canonical JSON of the graph section (object keys sorted recursively). Used for fingerprints, so key order in the source document does not matter.

Trait Implementations§

Source§

impl Clone for Workflow

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Workflow

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Workflow

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Serialize for Workflow

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.