pipette_client::shell

Struct Cmd

Source
pub struct Cmd<'a, T: for<'enc> Utf8Encoding<'enc>> { /* private fields */ }
Expand description

A command builder.

Implementations§

Source§

impl<'a, T: for<'enc> Utf8Encoding<'enc>> Cmd<'a, T>

Source

pub fn arg<P: AsRef<str>>(self, arg: P) -> Self

Adds an argument to the command.

Source

pub fn args<I>(self, args: I) -> Self
where I: IntoIterator, I::Item: AsRef<str>,

Adds multiple arguments to the command.

Source

pub fn env(self, key: impl AsRef<str>, val: impl AsRef<str>) -> Self

Sets an environment variable for the command.

Source

pub fn envs<I, K, V>(self, vars: I) -> Self
where I: IntoIterator<Item = (K, V)>, K: AsRef<str>, V: AsRef<str>,

Sets multiple environment variables for the command.

Source

pub fn env_remove(self, key: impl AsRef<str>) -> Self

Removes an environment variable for the command.

Source

pub fn env_clear(self) -> Self

Clears the environment for the command.

Source

pub fn ignore_status(self) -> Self

Ignores the status of the command.

By default, the command will fail if the exit code is non-zero.

Source

pub fn ignore_stdout(self) -> Self

Ignores the stdout of the command.

By default, the command’s stdout will be captured or printed to stdout.

Source

pub fn ignore_stderr(self) -> Self

Ignores the stderr of the command.

By default, the command’s stderr will be captured or printed to stderr.

Source

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

Sets contents to be written to the command’s stdin.

Source

pub async fn run(&self) -> Result<()>

Runs the command and waits for it to complete.

By default, this will fail if the command’s exit code is non-zero.

By default, the command’s stdout and stderr will be captured and traced.

Source

pub async fn read(&self) -> Result<String>

Runs the command and waits for it to complete, returning the stdout.

By default, this will fail if the command’s exit code is non-zero.

By default, the command’s stderr will be captured and traced.

Source

pub async fn read_stderr(&self) -> Result<String>

Runs the command and waits for it to complete, returning the stderr.

By default, this will fail if the command’s exit code is non-zero.

By default, the command’s stdout will be captured and traced.

Source

pub async fn output(&self) -> Result<Output>

Runs the command and waits for it to complete, returning the stdout and stderr.

By default, this will fail if the command’s exit code is non-zero.

Auto Trait Implementations§

§

impl<'a, T> Freeze for Cmd<'a, T>

§

impl<'a, T> !RefUnwindSafe for Cmd<'a, T>

§

impl<'a, T> Send for Cmd<'a, T>
where T: Send + Sync,

§

impl<'a, T> Sync for Cmd<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for Cmd<'a, T>
where T: Unpin,

§

impl<'a, T> !UnwindSafe for Cmd<'a, T>

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more