Struct xscript::Cmd

pub struct Cmd<S: CmdString = OsString>(/* private fields */);

A command.

Implementations

impl<S: CmdString> Cmd<S>

pub fn new<P: AsRef<S::Str>>(prog: P) -> Self

Creates a new command for the given program.

pub fn prog(&self) -> &S::Str

The program to run.

pub fn args(&self) -> impl Iterator<Item = &S::Str>

The arguments to run the program with.

pub fn cwd(&self) -> Option<&S::Str>

The directory in which to run the command, if any.

pub fn vars(&self) -> Option<&Vars<S>>

The environment variables to run the command with.

pub fn stdin(&self) -> Option<&In>

The stdin input to provide to the command.

pub fn stdout(&self) -> Option<&Out>

Indicates what to do with the stdout output of the command.

pub fn stderr(&self) -> Option<&Out>

Indicates what to do with the stderr output of the command.

pub fn may_fail(&self) -> bool

Indicates whether the command may fail.

pub fn is_secret(&self) -> bool

Hints that the command may contain secret information.

pub fn add_arg<A: AsRef<S::Str>>(&mut self, arg: A) -> &mut Self

Adds an argument to the command.

pub fn extend_args<A: AsRef<S::Str>, I: IntoIterator<Item = A>>( &mut self, args: I ) -> &mut Self

Extends the arguments of the command.

pub fn with_cwd<P: AsRef<S::Str>>(self, cwd: P) -> Self

Sets the directory in which to run the command.

pub fn with_vars(self, vars: Vars<S>) -> Self

Sets the environment variables to run the command with.

pub fn with_var<N: AsRef<S::Str>, V: AsRef<S::Str>>( self, name: N, value: V ) -> Self

Sets an environment variable.

pub fn with_stdin<T: Into<In>>(self, stdin: T) -> Self

Sets the stdin input to provide to the command.

pub fn with_stdout(self, stdout: Out) -> Self

Sets what to do with the stdout output of the command.

pub fn with_stderr(self, stderr: Out) -> Self

Sets what to do with the stderr output of the command.

pub fn allow_failures(self) -> Self

Do not return an error when the command fails.

pub fn make_secret(self) -> Self

Mark the command as secret.

Trait Implementations

impl<S: CmdString> AsRef<Cmd<S>> for Cmd<S>

fn as_ref(&self) -> &Cmd<S>

Converts this type into a shared reference of the (usually inferred) input type.

impl<S: Clone + CmdString> Clone for Cmd<S>

fn clone(&self) -> Cmd<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug + CmdString> Debug for Cmd<S>

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

Formats the value using the given formatter.

impl<'de, S> Deserialize<'de> for Cmd<S>

where S: Deserialize<'de> + CmdString,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S: CmdString> Display for Cmd<S>

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

Formats the value using the given formatter.

impl<S> Serialize for Cmd<S>

where S: Serialize + CmdString,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.