Struct term_transcript::PtyCommand

pub struct PtyCommand { /* private fields */ }

Available on crate feature portable-pty only.

Command to spawn in a pseudo-terminal (PTY).

Examples

Since shell spawning is performed in a generic way, PtyCommand can be used as a drop-in replacement for Command:

let transcript = Transcript::from_inputs(
    &mut ShellOptions::new(PtyCommand::default()),
    vec![UserInput::command(r#"echo "Hello world!""#)],
)?;
// do something with `transcript`...

Implementations

impl PtyCommand

pub fn new(command: impl Into<OsString>) -> Self

Creates a new command based on the executable.

This uses a reasonable default for the PTY size (19 character rows, 80 columns).

pub fn with_size(&mut self, rows: u16, cols: u16) -> &mut Self

Sets the size of the PTY in characters.

pub fn arg(&mut self, arg: impl Into<OsString>) -> &mut Self

Adds a command argument.

Trait Implementations

impl Clone for PtyCommand

fn clone(&self) -> PtyCommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConfigureCommand for PtyCommand

fn current_dir(&mut self, dir: &Path)

Sets the current directory.

fn env(&mut self, name: &str, value: &OsStr)

Sets an environment variable.

impl Debug for PtyCommand

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

Formats the value using the given formatter.

impl Default for PtyCommand

fn default() -> Self

Returns the “default value” for a type.

impl SpawnShell for PtyCommand

type ShellProcess = PtyShell

Spawned shell process.

type Reader = Box<dyn Read + Send + 'static, Global>

Reader of the shell output.

type Writer = Box<dyn MasterPty + Send + 'static, Global>

Writer to the shell input.

fn spawn_shell(&mut self) -> Result<SpawnedShell<Self>>

Spawns a shell process.