Struct Command 

pub struct Command { /* private fields */ }

A process to spawn, as std::process::Command describes it.

Implementations

impl Command

pub fn new(program: impl AsRef<OsStr>) -> Self

A command for program, with its environment and working directory the process’s, and its standard streams inherited.

pub fn arg(&mut self, arg: impl AsRef<OsStr>) -> &mut Self

Adds an argument.

pub fn args<I, S>(&mut self, args: I) -> &mut Self

where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Adds arguments.

pub fn env( &mut self, key: impl AsRef<OsStr>, value: impl AsRef<OsStr>, ) -> &mut Self

Sets an environment variable of the child.

pub fn envs<I, K, V>(&mut self, vars: I) -> &mut Self

where I: IntoIterator<Item = (K, V)>, K: AsRef<OsStr>, V: AsRef<OsStr>,

Sets environment variables of the child.

pub fn env_remove(&mut self, key: impl AsRef<OsStr>) -> &mut Self

Takes an environment variable out of the child’s environment.

pub fn env_clear(&mut self) -> &mut Self

Starts the child with no environment but what is set after.

pub fn current_dir(&mut self, dir: impl AsRef<Path>) -> &mut Self

Sets the child’s working directory.

pub fn stdin(&mut self, cfg: impl Into<Stdio>) -> &mut Self

Sets the child’s stdin.

pub fn stdout(&mut self, cfg: impl Into<Stdio>) -> &mut Self

Sets the child’s stdout.

pub fn stderr(&mut self, cfg: impl Into<Stdio>) -> &mut Self

Sets the child’s stderr.

pub fn kill_on_drop(&mut self, kill: bool) -> &mut Self

Whether the child is ended, as Child::start_kill ends it, when its Child is dropped before it exits (default false: it runs on, and is still reaped once it exits).

use nuclei::process::Command;

let child = Command::new("sleep").arg("60").kill_on_drop(true).spawn()?;
drop(child); // the child is ended here

pub fn get_kill_on_drop(&self) -> bool

Whether kill_on_drop is set.

pub fn as_std(&self) -> &Command

The std command underneath, for what this one does not mirror.

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

The std command underneath, to change.

pub fn into_std(self) -> Command

The std command underneath, taken.

pub fn spawn(&mut self) -> Result<Child>

Spawns the child. Its piped streams are async.

Errors

When the child cannot start, or its pipes cannot be taken over.

pub fn spawn_with( &mut self, with: impl FnOnce(&mut Command) -> Result<Child>, ) -> Result<Child>

Spawns the child through with, which starts it from the std command underneath: for a way to start a child this type does not mirror, such as a platform’s own spawn call with extra attributes. The child with returns is then this one’s, its piped streams async.

use nuclei::process::Command;

let mut child = Command::new("true").spawn_with(|std| std.spawn())?;
assert!(child.wait().await?.success());

Errors

What with returns, and when the child’s pipes cannot be taken over.

pub async fn status(&mut self) -> Result<ExitStatus>

Spawns the child and waits for its exit; its streams are inherited unless set.

Errors

As for spawn and Child::wait.

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

Spawns the child with its stdout and stderr piped (and its stdin empty, unless set), and collects both until its exit.

Errors

As for spawn and Child::wait_with_output.

Trait Implementations

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(std: Command) -> Self

Converts to this type from the input type.