Struct xshell::Cmd[−][src]

#[must_use]
pub struct Cmd { /* fields omitted */ }

A command.

Implementations

impl Cmd[src]

pub fn new(program: impl AsRef<Path>) -> Cmd[src]

Creates a new Cmd that executes the given program.

pub fn arg(self, arg: impl AsRef<OsStr>) -> Cmd[src]

Pushes an argument onto this Cmd.

pub fn args<I>(self, args: I) -> Cmd where
    I: IntoIterator,
    I::Item: AsRef<OsStr>, [src]

Pushes the arguments onto this Cmd.

pub fn ignore_status(self) -> Cmd[src]

Returns a Cmd that ignores its exit status.

pub fn stdin(self, stdin: impl AsRef<[u8]>) -> Cmd[src]

Returns a Cmd with the given stdin.

pub fn echo_cmd(self, echo: bool) -> Cmd[src]

Returns a Cmd that echoes itself (or not) as specified.

pub fn secret(self, secret: bool) -> Cmd[src]

Returns a Cmd that is secret (or not) as specified.

If a command is secret, it echoes <secret> instead of the program and its arguments.

pub fn read(self) -> Result<String>[src]

Returns the stdout from running the command.

pub fn read_stderr(self) -> Result<String>[src]

Returns the stderr from running the command.

pub fn output(self) -> Result<Output>[src]

Returns a std::process::Output from running the command.

pub fn run(self) -> Result<()>[src]

Runs the command.

Trait Implementations

impl Debug for Cmd[src]

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

Formats the value using the given formatter. Read more

impl Display for Cmd[src]

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl RefUnwindSafe for Cmd

impl Send for Cmd

impl Sync for Cmd

impl Unpin for Cmd

impl UnwindSafe for Cmd

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

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

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToString for T where
    T: Display + ?Sized, [src]

pub default fn to_string(&self) -> String[src]

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.