Struct Workflow

pub struct Workflow {
    pub strings: WorkflowStrings,
    /* private fields */
}

Contains all the information about a workflow, in a form that can be used to generate a traversal to run.

Fields

strings: WorkflowStrings

All strings defined in the config file

Implementations

impl Workflow

pub fn load(&mut self, blocks: Vec<Item<'_>>, config_dir: &Path) -> Result<()>

Load the given ast representations of blocks into this Workflow. config_dir is used to interpret relative paths to modules.

pub fn sizes(&self) -> &SizeHints

Get a reference to size hints for initializing collections.

pub fn get_module_path(&self, module: ModuleId) -> Result<&str>

Get a string containing the path to the module with the given id.

pub fn get_task(&self, task: AbstractTaskId) -> Result<&Task, Error>

Get the task with the given id.

pub fn get_value(&self, value: AbstractValueId) -> Result<&Value, Error>

Get the value with the given id.

pub fn get_config_value(&self, ident: IdentId) -> Option<AbstractValueId>

pub fn num_values(&self) -> usize

Total number of values defined (including task variables and config values).

pub fn get_plan(&self, plan_name: IdentId) -> Result<&Plan, Error>

Get a reference to the plan defined with the given identifier.

pub fn parse_compact_branch_str(&mut self, s: &str) -> Result<BranchSpec>

Parse “compact” branch string (i.e. with “Baseline.baseline” standing in for baseline branches) into a BranchSpec.

Trait Implementations

impl Debug for Workflow

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

Formats the value using the given formatter.

impl Default for Workflow

fn default() -> Self

Returns the “default value” for a type.