Struct Command

pub struct Command { /* private fields */ }

A process builder that allows you to spawn programs.

Implementations

impl Command

pub fn new(program: impl ToString) -> Self

Creates a new Command that will spawn the provided program.

pub fn with_shell( shell_args: impl IntoIterator<Item = impl ToString>, command: impl ToString, ) -> Self

Creates a new Command that will spawn the provided command using the given shell and its arguments.

Examples

Command::with_shell(["bash", "-c"], "cat file.txt &> /dev/null").spawn();

pub fn arg(&mut self, arg: impl ToString) -> &mut Self

Adds an argument to the command.

pub fn args( &mut self, args: impl IntoIterator<Item = impl ToString>, ) -> &mut Self

Adds multiple arguments to the command.

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

Sets an environment variable that the process will spawn with.

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

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

Sets multiple environment variables that the process will spawn with.

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

Causes this command to only spawn the program if it is the only instance currently running.

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

Causes this command to spawn the program exactly once in the compositor’s lifespan.

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

Sets up a pipe to allow the config to write to the process’s stdin.

The pipe will be available through the spawned child’s stdin.

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

Sets up a pipe to allow the config to read from the process’s stdout.

The pipe will be available through the spawned child’s stdout.

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

Sets up a pipe to allow the config to read from the process’s stderr.

The pipe will be available through the spawned child’s stderr.

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

Spawns this command, returning the spawned process’s standard io, if any.