Enum Command

pub enum Command {
    Std(Command),
    Tokio(Command),
}

Available on crate feature process only.

An enum that can wrap std::process::Command or tokio::process::Command and can Clone.

Note that Cloning Command is a lossy clone, which will lose platform specific options such as: pre_exec, creation_flags, etc.

See: https://users.rust-lang.org/t/is-there-any-way-to-clone-a-std-command/121905

Variants

Std(Command)

Tokio(Command)

Implementations

impl Command

pub fn std<S: AsRef<OsStr>>(program: S) -> Self

Create a new Command wrapped with std::process::Command.

See: std::process::Command::new

pub fn tokio_default<S: AsRef<OsStr>>(program: S) -> Self

Create a new Command wrapped with tokio::process::Command.

See: tokio::process::Command::new

pub fn tokio_config<S: AsRef<OsStr>>(program: S, kill_on_drop: bool) -> Self

Create a new Command wrapped with tokio::process::Command with kill_on_drop option.

See:

• tokio::process::Command::new
• tokio::process::Command::kill_on_drop

pub fn wrapping_std(&self) -> bool

Check whether Self is wrapped with std::process::Command.

pub fn wrapping_tokio(&self) -> bool

Check whether Self is wrapped with tokio::process::Command.

pub fn as_std(&self) -> &StdCommand

Cheaply convert to a &std::process::Command for places where the type from the standard library is expected.

This method will return &std::process::Command even if it is wrapping tokio::process::Command.

See: tokio::process::Command::as_std

pub fn as_std_mut(&mut self) -> &mut StdCommand

Cheaply convert to a &mut std::process::Command for places where the type from the standard library is expected.

This method will return &mut std::process::Command even if it is wrapping tokio::process::Command.

See: tokio::process::Command::as_std_mut

pub fn as_tokio(&self) -> Option<&TokioCommand>

If the instance is wrapping tokio::process::Command, it returns Some(&tokio::process::Command), otherwise it returns None.

pub fn as_tokio_mut(&mut self) -> Option<&mut TokioCommand>

If the instance is wrapping tokio::process::Command, it returns Some(&mut tokio::process::Command), otherwise it returns None.

pub fn into_std(self) -> StdCommand

Cheaply convert into a std::process::Command.

Note that if the instance is wrapping tokio::process::Command, Tokio specific options will be lost. Currently, this only applies to kill_on_drop.

See: tokio::process::Command::into_std

pub fn into_tokio(self) -> TokioCommand

Cheaply convert into a tokio::process::Command.

Note that if the instance is wrapping the std::process::Command, kill_on_drop will use the default value of false.

pub fn convert_to_std(self) -> Self

Consume Self, convert it to std::process::Command, and then return a new instance that wraps it.

pub fn convert_to_tokio(self) -> Self

Consume Self, convert it to tokio::process::Command, and then return a new instance that wraps it.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Self

Returns a copy 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 From<Command> for Command

fn from(value: StdCommand) -> Self

Converts to this type from the input type.

impl From<Command> for Command

fn from(value: Command) -> Self

Converts to this type from the input type.

impl From<Command> for Command

fn from(value: TokioCommand) -> Self

Converts to this type from the input type.

impl From<Command> for Command

fn from(value: Command) -> Self

Converts to this type from the input type.