Struct Command

pub struct Command { /* private fields */ }

A command to be run in a virtual terminal

Implementations

impl Command

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

Create a new command

pub fn in_tx(&self) -> Sender<Input>

Get the sender for sending input to the command

pub fn out_tx(&self) -> Sender<Output>

Get the output sender, useful e.g. to manually send empty output frames to the terminal handler

pub fn out_rx(&self) -> Receiver<Output>

Get the receiver for receiving output from the command

pub fn terminal_id<S: Into<String>>(self, terminal_id: S) -> Self

Set the terminal id

pub fn terminal_size(self, terminal_size: (usize, usize)) -> Self

Set the terminal size

pub fn shutdown_timeout(self, timeout: Duration) -> Self

Set the shutdown timeout to collect the command output

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

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

Set the program arguments

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

Add a program argument

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

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

Set the environment variables

pub fn env<K: AsRef<OsStr>, V: AsRef<OsStr>>(self, key: K, value: V) -> Self

Add an environment variable

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

Set the working directory

pub async fn run(self)

Run the command

Trait Implementations

impl Drop for Command

fn drop(&mut self)

Executes the destructor for this type.