Struct Command

pub struct Command { /* private fields */ }

Available on crate feature async only.

Wrapper around tokio::process::Command

Implementations

impl Command

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

See tokio::process::Command::new

pub fn arg<S: AsRef<OsStr>>(self, arg: S) -> Self

See tokio::process::Command::arg

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

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

See tokio::process::Command::args

pub fn env<K, V>(self, key: K, val: V) -> Self

where K: AsRef<OsStr>, V: AsRef<OsStr>,

See tokio::process::Command::env

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

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

See tokio::process::Command::envs

pub fn env_remove<K: AsRef<OsStr>>(self, key: K) -> Self

See tokio::process::Command::env_remove

pub fn env_clear(self) -> Self

See tokio::process::Command::env_clear

pub fn current_dir<P: AsRef<Path>>(self, dir: P) -> Self

See tokio::process::Command::current_dir

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

See tokio::process::Command::kill_on_drop

pub fn stdin<T: Into<Stdio>>(self, cfg: T) -> Self

See tokio::process::Command::stdin

pub fn stdout<T: Into<Stdio>>(self, cfg: T) -> Self

See tokio::process::Command::stdout

pub fn stderr<T: Into<Stdio>>(self, cfg: T) -> Self

See tokio::process::Command::stderr

pub fn spawn(self, pts: Pts) -> Result<Child>

Executes the command as a child process via tokio::process::Command::spawn on the given pty. The pty will be attached to all of stdin, stdout, and stderr of the child, unless those file descriptors were previously overridden through calls to stdin, stdout, or stderr. The newly created child process will also be made the session leader of a new session, and will have the given pty set as its controlling terminal.

Errors

Returns an error if we fail to allocate new file descriptors for attaching the pty to the child process, or if we fail to spawn the child process (see the documentation for tokio::process::Command::spawn), or if we fail to make the child a session leader or set its controlling terminal.

pub fn spawn_borrowed(&mut self, pts: &Pts) -> Result<Child>

Available on non-macOS only.

Executes the command as a child process via tokio::process::Command::spawn on the given pty. The pty will be attached to all of stdin, stdout, and stderr of the child, unless those file descriptors were previously overridden through calls to stdin, stdout, or stderr. The newly created child process will also be made the session leader of a new session, and will have the given pty set as its controlling terminal.

Differs from spawn in that it borrows the pty rather than consuming it, allowing for multiple commands to be spawned onto the same pty in sequence, but this functionality is not available on macos.

Errors

Returns an error if we fail to allocate new file descriptors for attaching the pty to the child process, or if we fail to spawn the child process (see the documentation for tokio::process::Command::spawn), or if we fail to make the child a session leader or set its controlling terminal.

pub fn uid(self, id: u32) -> Self

See tokio::process::Command::uid

pub fn gid(self, id: u32) -> Self

See tokio::process::Command::gid

pub unsafe fn pre_exec<F>(self, f: F) -> Self

where F: FnMut() -> Result<()> + Send + Sync + 'static,

See tokio::process::Command::pre_exec

pub fn arg0<S>(self, arg: S) -> Self

where S: AsRef<OsStr>,

See tokio::process::Command::arg0