Struct WorkflowInputs

pub struct WorkflowInputs { /* private fields */ }

Represents inputs to a workflow.

Implementations

impl WorkflowInputs

pub fn iter(&self) -> impl Iterator<Item = (&str, &Value)> + use<'_>

Iterates the inputs to the workflow.

pub fn get(&self, name: &str) -> Option<&Value>

Gets an input by name.

pub fn calls(&self) -> &HashMap<String, Inputs>

Gets the nested call inputs.

pub fn calls_mut(&mut self) -> &mut HashMap<String, Inputs>

Gets the nested call inputs.

pub fn set( &mut self, name: impl Into<String>, value: impl Into<Value>, ) -> Option<Value>

Sets a workflow input.

Returns the previous value, if any.

pub fn contains(&self, name: &str) -> bool

Checks if the inputs contain a value with the specified name.

This does not check nested call inputs.

pub fn join_paths<'a>( &mut self, workflow: &Workflow, path: impl Fn(&str) -> Result<&'a Path>, ) -> Result<()>

Replaces any File or Directory input values with joining the specified path with the value.

This method will attempt to coerce matching input values to their expected types.

pub fn validate( &self, document: &Document, workflow: &Workflow, specified: Option<&HashSet<String>>, ) -> Result<()>

Validates the inputs for the given workflow.

The specified set of inputs are those that are present, but may not have values available at validation.

Trait Implementations

impl Clone for WorkflowInputs

fn clone(&self) -> WorkflowInputs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowInputs

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

Formats the value using the given formatter.

impl Default for WorkflowInputs

fn default() -> WorkflowInputs

Returns the “default value” for a type.

impl From<WorkflowInputs> for Inputs

fn from(inputs: WorkflowInputs) -> Self

Converts to this type from the input type.

impl<S, V> FromIterator<(S, V)> for WorkflowInputs

where S: Into<String>, V: Into<Value>,

fn from_iter<T: IntoIterator<Item = (S, V)>>(iter: T) -> Self

Creates a value from an iterator.

impl Serialize for WorkflowInputs

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.