Struct workflow::WorkflowExecutor

pub struct WorkflowExecutor { /* fields omitted */ }

The WorkflowExecutor is use to define the executing context of a workflow it is composed of a local cache of workflows that will be provided at runtime for the running workflows to resolve.

Implementations

impl WorkflowExecutor

pub fn with_cache<P: AsRef<Path>>(cache_dir: P) -> Result<Self, Box<dyn Error>>

with_cache create a new WorkflowExecutor and load a local cache of workflows by searching for workflow file definition in given directory.

use workflow::WorkflowExecutor;
use std::path::Path;
let executor = WorkflowExecutor::with_cache(Path::new("workflows")).expect("unable to load cache");

pub fn execute(&self, workflow: &Workflow) -> Result<(), Box<dyn Error>>

execute will execute given Workflow using the executor, passing the context to the workflow.

this method is the main entry point.

use workflow::{WorkflowExecutor, Workflow};
use std::path::Path;
let executor = WorkflowExecutor::with_cache(Path::new("workflows")).expect("unable to load cache");

let workflow = Workflow::from_file(Path::new("workflow.yml")).expect("unable to load workflow");

executor.execute(&workflow).expect("unable to execute workflow");

Trait Implementations

impl Default for WorkflowExecutor

fn default() -> WorkflowExecutor

Returns the "default value" for a type.