[][src]Struct cargo_make::types::Task

pub struct Task {
    pub clear: Option<bool>,
    pub description: Option<String>,
    pub category: Option<String>,
    pub disabled: Option<bool>,
    pub private: Option<bool>,
    pub workspace: Option<bool>,
    pub condition: Option<TaskCondition>,
    pub condition_script: Option<Vec<String>>,
    pub force: Option<bool>,
    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<String>,
    pub install_crate_args: Option<Vec<String>>,
    pub install_script: Option<Vec<String>>,
    pub command: Option<String>,
    pub args: Option<Vec<String>>,
    pub script: Option<Vec<String>>,
    pub script_runner: Option<String>,
    pub script_extension: Option<String>,
    pub run_task: Option<String>,
    pub dependencies: Option<Vec<String>>,
    pub linux: Option<PlatformOverrideTask>,
    pub windows: Option<PlatformOverrideTask>,
    pub mac: Option<PlatformOverrideTask>,
}

Holds a single task configuration such as command and dependencies list

Fields

if true, it should ignore all data in base task

Task description

Category name used to document the task

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

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

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)

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

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

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

The env vars to setup before running the task commands

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

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

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

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

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

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

additional cargo install arguments

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

The command to execute

The command args

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

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

The script file extension

The task name to execute

A list of tasks to execute before this task

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

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

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

Methods

impl Task
[src]

Creates and returns a new instance.

Copies values from the task into self.

Arguments

  • task - The task to copy from

Returns true if the task force attribute is defined and true

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

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

Returns true if the task is valid

Trait Implementations

impl Debug for Task
[src]

Formats the value using the given formatter. Read more

impl Clone for Task
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl Send for Task

impl Sync for Task

Blanket Implementations

impl<T> From for T
[src]

Performs the conversion.

impl<T, U> Into for T where
    U: From<T>, 
[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone
[src]

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T> Borrow for T where
    T: ?Sized
[src]

Immutably borrows from an owned value. Read more

impl<T> Any for T where
    T: 'static + ?Sized
[src]

🔬 This is a nightly-only experimental API. (get_type_id)

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T> BorrowMut for T where
    T: ?Sized
[src]

Mutably borrows from an owned value. Read more

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