Struct Command 

#[non_exhaustive]
pub struct Command {
    pub name: String,
    pub env: Vec<String>,
    pub args: Vec<String>,
    pub dir: String,
    pub id: String,
    pub wait_for: Vec<String>,
    /* private fields */
}

Command describes a step performed as part of the build pipeline.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Required. Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to docker pull.

env: Vec<String>

Environment variables set before running this command.

args: Vec<String>

Command-line arguments used when executing this command.

dir: String

Working directory (relative to project source root) used when running this command.

id: String

Optional unique identifier for this command, used in wait_for to reference this command as a dependency.

wait_for: Vec<String>

The ID(s) of the command(s) that this command depends on.

Implementations

impl Command

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = Command::new().set_name("example");

pub fn set_env<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of env.

Example

let x = Command::new().set_env(["a", "b", "c"]);

pub fn set_args<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of args.

Example

let x = Command::new().set_args(["a", "b", "c"]);

pub fn set_dir<T: Into<String>>(self, v: T) -> Self

Sets the value of dir.

Example

let x = Command::new().set_dir("example");

pub fn set_id<T: Into<String>>(self, v: T) -> Self

Sets the value of id.

Example

let x = Command::new().set_id("example");

pub fn set_wait_for<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of wait_for.

Example

let x = Command::new().set_wait_for(["a", "b", "c"]);

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl Default for Command

fn default() -> Command

Returns the “default value” for a type.

impl Message for Command

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Command

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