Struct cli::types::Task

source ·
pub struct Task {
Show 37 fields pub clear: Option<bool>, pub description: Option<String>, pub category: Option<String>, pub disabled: Option<bool>, pub private: Option<bool>, pub deprecated: Option<DeprecationInfo>, pub extend: Option<String>, pub workspace: Option<bool>, pub plugin: Option<String>, pub watch: Option<TaskWatchOptions>, pub condition: Option<TaskCondition>, pub condition_script: Option<ConditionScriptValue>, pub condition_script_runner_args: Option<Vec<String>>, pub ignore_errors: Option<bool>, pub force: Option<bool>, pub env_files: Option<Vec<EnvFile>>, pub env: Option<IndexMap<String, EnvValue>>, pub cwd: Option<String>, pub alias: Option<String>, pub linux_alias: Option<String>, pub windows_alias: Option<String>, pub mac_alias: Option<String>, pub install_crate: Option<InstallCrate>, pub install_crate_args: Option<Vec<String>>, pub install_script: Option<ScriptValue>, pub command: Option<String>, pub args: Option<Vec<String>>, pub script: Option<ScriptValue>, pub script_runner: Option<String>, pub script_runner_args: Option<Vec<String>>, pub script_extension: Option<String>, pub run_task: Option<RunTaskInfo>, pub dependencies: Option<Vec<DependencyIdentifier>>, pub toolchain: Option<ToolchainSpecifier>, pub linux: Option<PlatformOverrideTask>, pub windows: Option<PlatformOverrideTask>, pub mac: Option<PlatformOverrideTask>,
}
Expand description

Holds a single task configuration such as command and dependencies list

Fields§

§clear: Option<bool>

if true, it should ignore all data in base task

§description: Option<String>

Task description

§category: Option<String>

Category name used to document the task

§disabled: Option<bool>

if true, the command/script of this task will not be invoked, dependencies however will be

§private: Option<bool>

if true, the task is hidden from the list of available tasks and also cannot be invoked directly from cli

§deprecated: Option<DeprecationInfo>

if not false, this task is defined as deprecated

§extend: Option<String>

Extend any task based on the defined name

§workspace: Option<bool>

set to false to notify cargo-make that this is not a workspace and should not call task for every member (same as –no-workspace CLI flag)

§plugin: Option<String>

Optional plugin used to execute the task

§watch: Option<TaskWatchOptions>

set to true to watch for file changes and invoke the task operation

§condition: Option<TaskCondition>

if provided all condition values must be met in order for the task to be invoked (will not stop dependencies)

§condition_script: Option<ConditionScriptValue>

if script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

§condition_script_runner_args: Option<Vec<String>>

The script runner arguments before the script file path

§ignore_errors: Option<bool>

if true, any error while executing the task will be printed but will not break the build

§force: Option<bool>

DEPRECATED, replaced with ignore_errors

§env_files: Option<Vec<EnvFile>>

The env files to setup before running the task commands

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

The env vars to setup before running the task commands

§cwd: Option<String>

The working directory for the task to execute its command/script

§alias: Option<String>

if defined, task points to another task and all other properties are ignored

§linux_alias: Option<String>

acts like alias if runtime OS is Linux (takes precedence over alias)

§windows_alias: Option<String>

acts like alias if runtime OS is Windows (takes precedence over alias)

§mac_alias: Option<String>

acts like alias if runtime OS is Mac (takes precedence over alias)

§install_crate: Option<InstallCrate>

if defined, the provided crate will be installed (if needed) before running the task

§install_crate_args: Option<Vec<String>>

additional cargo install arguments

§install_script: Option<ScriptValue>

if defined, the provided script will be executed before running the task

§command: Option<String>

The command to execute

§args: Option<Vec<String>>

The command args

§script: Option<ScriptValue>

If command is not defined, and script is defined, the provided script will be executed

§script_runner: Option<String>

The script runner (defaults to cmd in windows and sh for other platforms)

§script_runner_args: Option<Vec<String>>

The script runner arguments before the script file path

§script_extension: Option<String>

The script file extension

§run_task: Option<RunTaskInfo>

The task name to execute

§dependencies: Option<Vec<DependencyIdentifier>>

A list of tasks to execute before this task

§toolchain: Option<ToolchainSpecifier>

The rust toolchain used to invoke the command or install the needed crates/components

§linux: Option<PlatformOverrideTask>

override task if runtime OS is Linux (takes precedence over alias)

§windows: Option<PlatformOverrideTask>

override task if runtime OS is Windows (takes precedence over alias)

§mac: Option<PlatformOverrideTask>

override task if runtime OS is Mac (takes precedence over alias)

Implementations§

source§

impl Task

source

pub fn new() -> Task

Creates and returns a new instance.

source

pub fn apply(self: &mut Task, modify_config: &ModifyConfig)

Apply modifications

source

pub fn extend(self: &mut Task, task: &Task)

Copies values from the task into self.

§Arguments
  • task - The task to copy from
source

pub fn should_ignore_errors(self: &Task) -> bool

Returns true if the task ignore_errors attribute is defined and true

source

pub fn get_normalized_task(self: &mut Task) -> Task

Returns a new task based on the override information and current platform.

source

pub fn get_alias(self: &Task) -> Option<String>

Returns the alias value based on the current platform and task definition.

source

pub fn get_actions_count(self: &Task) -> u8

Returns the amount of actions defined on the task

source

pub fn is_actionable(self: &Task) -> bool

Returns true if the task has any actions on its own or if it modifies the environment in any way.

source

pub fn is_valid(self: &Task) -> bool

Returns true if the task is valid

Trait Implementations§

source§

impl Clone for Task

source§

fn clone(&self) -> Task

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Task

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Task

source§

fn default() -> Task

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for Task

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Serialize for Task

source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Task

§

impl RefUnwindSafe for Task

§

impl Send for Task

§

impl Sync for Task

§

impl Unpin for Task

§

impl UnwindSafe for Task

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,