Struct TaskInputs

pub struct TaskInputs { /* private fields */ }

Represents inputs to a task.

Implementations

impl TaskInputs

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

Iterates the inputs to the task.

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

Gets an input by name.

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

Sets a task input.

Returns the previous value, if any.

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

Gets an overridden requirement by name.

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

Overrides a requirement by name.

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

Gets an overridden hint by name.

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

Overrides a hint by name.

pub fn join_paths<'a>( &mut self, task: &Task, 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, task: &Task, specified: Option<&HashSet<String>>, ) -> Result<()>

Validates the inputs for the given task.

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

Trait Implementations

impl Clone for TaskInputs

fn clone(&self) -> TaskInputs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TaskInputs

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

Formats the value using the given formatter.

impl Default for TaskInputs

fn default() -> TaskInputs

Returns the “default value” for a type.

impl From<TaskInputs> for Inputs

fn from(inputs: TaskInputs) -> Self

Converts to this type from the input type.

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

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 TaskInputs

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

where S: Serializer,

Serialize this value into the given Serde serializer.