Struct TtySpawn

pub struct TtySpawn { /* private fields */ }

Lets you spawn processes with a TTY connected.

Implementations

impl TtySpawn

pub fn new<S: AsRef<OsStr>>(cmd: S) -> TtySpawn

Creates a new TtySpawn for a given command.

pub fn new_cmdline<S: AsRef<OsStr>, I: Iterator<Item = S>>(cmdline: I) -> Self

Alternative way to construct a TtySpawn.

Takes an iterator of command and arguments. If the iterator is empty this panicks.

Panicks

If the iterator is empty, this panics.

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

Adds a new argument to the command.

pub fn args<S: AsRef<OsStr>, I: Iterator<Item = S>>( &mut self, args: I, ) -> &mut Self

Adds multiple arguments from an iterator.

pub fn stdin_file(&mut self, f: File) -> &mut Self

Sets an input file for stdin.

It’s recommended that this is a named pipe and as a general recommendation this file should be opened with O_NONBLOCK.

Platform Specifics

While we will never write into the file it’s strongly recommended to ensure that the file is opened writable too. The reason for this is that on Linux, if the last writer (temporarily) disconnects from a FIFO polling primitives such as the one used by tty-spawn will keep reporting that the file is ready while there not actually being any more data coming in. The solution to this problem is to ensure that there is at least always one writer open which can be ensured by also opening this file for writing.

pub fn stdin_path<P: AsRef<Path>>( &mut self, path: P, ) -> Result<&mut Self, Error>

Sets a path as input file for stdin.

pub fn stdout_file(&mut self, f: File) -> &mut Self

Sets an output file for stdout.

pub fn stdout_path<P: AsRef<Path>>( &mut self, path: P, truncate: bool, ) -> Result<&mut Self, Error>

Sets a path as output file for stdout.

If the truncate flag is set to true the file will be truncated first, otherwise it will be appended to.

pub fn script_mode(&mut self, yes: bool) -> &mut Self

Enables script mode.

In script mode stdout/stderr are retained as separate streams, the terminal is not opened in raw mode. Additionally some output processing is disabled so usually you will find LF retained and not converted to CLRF. This will also attempt to disable pagers and turn off ECHO intelligently in some cases.

pub fn flush(&mut self, yes: bool) -> &mut Self

Can be used to turn flushing off.

By default output is flushed constantly.

pub fn echo(&mut self, yes: bool) -> &mut Self

Can be used to turn echo off.

By default echo is turned on.

pub fn pager(&mut self, yes: bool) -> &mut Self

Tries to use cat as pager.

When this is enabled then processes are instructed to use cat as pager. This is useful when raw terminals are disabled in which case most pagers will break.

pub fn raw(&mut self, yes: bool) -> &mut Self

Can be used to turn raw terminal mode off.

By default the terminal is in raw mode but in some cases you might want to turn this off. If raw mode is disabled then pagers will not work and so will most input operations.

pub fn spawn(&mut self) -> Result<i32, Error>

Spawns the application in the TTY.