Struct TaskConfig 

pub struct TaskConfig {

    pub extends: Option<Id>,
    pub description: Option<String>,
    pub command: TaskArgs,
    pub args: TaskArgs,
    pub deps: Option<Vec<TaskDependency>>,
    pub env: Option<IndexMap<String, Option<String>>>,
    pub global_inputs: Vec<Input>,
    pub inputs: Option<Vec<Input>>,
    pub outputs: Option<Vec<Output>>,
    pub options: TaskOptionsConfig,
    pub preset: Option<TaskPreset>,
    pub script: Option<String>,
    pub toolchains: Option<OneOrMany<Id>>,
    pub type_of: Option<TaskType>,
}

Configures a task to be ran within the action pipeline.

Fields

extends: Option<Id>

Extends settings from a sibling task by identifier.

description: Option<String>

A human-readable description about the task. @since 1.22.0

command: TaskArgs

The command line to execute when the task is ran. Supports the command (executable) with or without arguments. Can be defined as a string, or a list of individual arguments.

args: TaskArgs

Arguments to pass to the command when it’s ran. Can be defined as a string, or a list of individual arguments.

deps: Option<Vec<TaskDependency>>

Other tasks that this task depends on, and must run to completion before this task is ran. Can depend on sibling tasks, or tasks in other projects, using targets.

env: Option<IndexMap<String, Option<String>>>

A map of environment variables that will be set in the child process when the task is ran.

global_inputs: Vec<Input>

Internal only. Inputs defined through task inheritance.

inputs: Option<Vec<Input>>

A list of inputs that will be hashing and compared against changed files to determine affected status. If affected, the task will run, otherwise it will exit early. An input can be a literal file path, a glob pattern, environment variable, and more.

When not provided, all files within the project are considered inputs. When an empty list, no files are considered. Otherwise, an explicit list of inputs are considered.

outputs: Option<Vec<Output>>

A list of outputs that will be created when the task has successfully ran. An output can be a literal file path, or a glob pattern.

options: TaskOptionsConfig

Options to control task inheritance, execution, and more.

preset: Option<TaskPreset>

The preset to apply for the task. Will inherit default options.

script: Option<String>

A script to run within a shell. A script is anything from a single command, to multiple commands, or shell specific syntax. Does not support arguments, merging, or inheritance. This overrides command and args. @since 1.27.0

toolchains: Option<OneOrMany<Id>>

A toolchain, or list of toolchains, in which the task will inherit functionality from.

type_of: Option<TaskType>

The type of task, primarily used for categorical reasons. When not provided, will be automatically determined based on configured outputs.

Trait Implementations

impl Clone for TaskConfig

fn clone(&self) -> TaskConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for TaskConfig

type Partial = PartialTaskConfig

fn from_partial(partial: <TaskConfig as Config>::Partial) -> TaskConfig

Convert a partial configuration into a full configuration, with all values populated.

fn settings() -> BTreeMap<String, ConfigSetting>

Return a map of all settings and their metadata for the configuration.

impl Debug for TaskConfig

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

Formats the value using the given formatter.

impl Default for TaskConfig

fn default() -> TaskConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TaskConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<TaskConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TaskConfig

fn eq(&self, other: &TaskConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Schematic for TaskConfig

fn schema_name() -> Option<String>

Define a name for this schema type. Names are required for non-primitive values as a means to link references, and avoid cycles.

fn build_schema(schema: SchemaBuilder) -> Schema

Create and return a schema that models the structure of the implementing type. The schema can be used to generate code, documentation, or other artifacts.

impl Serialize for TaskConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TaskConfig

impl StructuralPartialEq for TaskConfig