Struct CommandBuilder 

pub struct CommandBuilder { /* private fields */ }

Available on crate feature terminal only.

CommandBuilder is used to prepare a command to be spawned into a pty. The interface is intentionally similar to that of std::process::Command.

Implementations

impl CommandBuilder

pub fn new<S>(program: S) -> CommandBuilder

where S: AsRef<OsStr>,

Create a new builder instance with argv[0] set to the specified program.

pub fn from_argv(args: Vec<OsString>) -> CommandBuilder

Create a new builder instance from a pre-built argument vector

pub fn set_controlling_tty(&mut self, controlling_tty: bool)

Set whether we should set the pty as the controlling terminal. The default is true, which is usually what you want, but you may need to set this to false if you are crossing container boundaries (eg: flatpak) to workaround issues like: https://github.com/flatpak/flatpak/issues/3697 https://github.com/flatpak/flatpak/issues/3285

pub fn get_controlling_tty(&self) -> bool

pub fn new_default_prog() -> CommandBuilder

Create a new builder instance that will run some idea of a default program. Such a builder will panic if arg is called on it.

pub fn is_default_prog(&self) -> bool

Returns true if this builder was created via new_default_prog

pub fn arg<S>(&mut self, arg: S)

where S: AsRef<OsStr>,

Append an argument to the current command line. Will panic if called on a builder created via new_default_prog.

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

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

Append a sequence of arguments to the current command line

pub fn get_argv(&self) -> &Vec<OsString>

pub fn get_argv_mut(&mut self) -> &mut Vec<OsString>

pub fn env<K, V>(&mut self, key: K, value: V)

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

Override the value of an environmental variable

pub fn env_remove<K>(&mut self, key: K)

where K: AsRef<OsStr>,

pub fn env_clear(&mut self)

pub fn get_env<K>(&self, key: K) -> Option<&OsStr>

where K: AsRef<OsStr>,

pub fn cwd<D>(&mut self, dir: D)

where D: AsRef<OsStr>,

pub fn clear_cwd(&mut self)

pub fn get_cwd(&self) -> Option<&OsString>

pub fn iter_extra_env_as_str(&self) -> impl Iterator<Item = (&str, &str)>

Iterate over the configured environment. Only includes environment variables set by the caller via env, not variables set in the base environment.

pub fn iter_full_env_as_str(&self) -> impl Iterator<Item = (&str, &str)>

pub fn as_unix_command_line(&self) -> Result<String, Error>

Return the configured command and arguments as a single string, quoted per the unix shell conventions.

impl CommandBuilder

pub fn umask(&mut self, mask: Option<u16>)

pub fn get_shell(&self) -> String

Determine which shell to run. We take the contents of the $SHELL env var first, then fall back to looking it up from the password database.

Trait Implementations

impl Clone for CommandBuilder

fn clone(&self) -> CommandBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommandBuilder

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

Formats the value using the given formatter.

impl PartialEq for CommandBuilder

fn eq(&self, other: &CommandBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CommandBuilder