Struct PartialTaskConfig 

pub struct PartialTaskConfig {

    pub extends: Option<Id>,
    pub description: Option<String>,
    pub command: Option<<TaskArgs as Config>::Partial>,
    pub args: Option<<TaskArgs as Config>::Partial>,
    pub deps: Option<Vec<<TaskDependency as Config>::Partial>>,
    pub env: Option<EnvMap>,
    pub global_inputs: Option<Vec<Input>>,
    pub inputs: Option<Vec<Input>>,
    pub outputs: Option<Vec<Output>>,
    pub options: Option<<TaskOptionsConfig as Config>::Partial>,
    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: Option<<TaskArgs as Config>::Partial>

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: Option<<TaskArgs as Config>::Partial>

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 as Config>::Partial>>

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<EnvMap>

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

global_inputs: Option<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: Option<<TaskOptionsConfig as Config>::Partial>

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 PartialTaskConfig

fn clone(&self) -> PartialTaskConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PartialTaskConfig

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

Formats the value using the given formatter.

impl Default for PartialTaskConfig

fn default() -> PartialTaskConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PartialTaskConfig

where PartialTaskConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialConfig for PartialTaskConfig

type Context = ()

fn default_values(context: &Self::Context) -> Result<Option<Self>, ConfigError>

Return a partial configuration with values populated with default values for settings marked with #[setting(default)]. Unmarked settings will be None.

fn env_values() -> Result<Option<Self>, ConfigError>

Return a partial configuration with values populated from environment variables for settings marked with #[setting(env)]. Unmarked settings will be None.

fn extends_from(&self) -> Option<ExtendsFrom>

When a setting is marked as extendable with #[setting(extend)], this returns ExtendsFrom with the extended sources, either a list of strings or a single string. When no setting is extendable, this returns None.

fn finalize(self, context: &Self::Context) -> Result<Self, ConfigError>

Finalize the partial configuration by consuming it and populating all fields with a value. Defaults values from PartialConfig::default_values will be applied first, followed by merging the current partial, and lastly environment variable values from PartialConfig::env_values.

fn merge( &mut self, context: &Self::Context, next: Self, ) -> Result<(), ConfigError>

Merge another partial configuration into this one and clone values when applicable. The following merge strategies are applied:

fn validate( &self, context: &Self::Context, finalize: bool, ) -> Result<(), ConfigError>

Recursively validate the configuration with the provided context. Validation should be done on the final state, after merging partials.

impl PartialEq for PartialTaskConfig

fn eq(&self, other: &PartialTaskConfig) -> 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 PartialTaskConfig

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 PartialTaskConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PartialTaskConfig