Struct ShellConfig 

pub struct ShellConfig {
    pub shell: Option<PathBuf>,
    pub args: Vec<String>,
    pub env: HashMap<String, String>,
    pub cwd: Option<PathBuf>,
    pub cols: u16,
    pub rows: u16,
    pub term: String,
    pub log_events: bool,
}

Configuration for spawning a shell process.

Fields

shell: Option<PathBuf>

Path to the shell executable. Defaults to $SHELL or /bin/sh if not set.

args: Vec<String>

Arguments to pass to the shell.

env: HashMap<String, String>

Environment variables to set in the shell.

cwd: Option<PathBuf>

Working directory for the shell.

cols: u16

PTY width in columns.

rows: u16

PTY height in rows.

term: String

TERM environment variable (defaults to “xterm-256color”).

log_events: bool

Enable logging of PTY events.

Implementations

impl ShellConfig

pub fn with_shell(shell: impl Into<PathBuf>) -> Self

Create a new configuration with the specified shell.

pub fn size(self, cols: u16, rows: u16) -> Self

Set the PTY dimensions.

pub fn arg(self, arg: impl Into<String>) -> Self

Add a shell argument.

pub fn env(self, key: impl Into<String>, value: impl Into<String>) -> Self

Set an environment variable.

pub fn inherit_env(self) -> Self

Inherit all environment variables from the parent process.

pub fn cwd(self, path: impl Into<PathBuf>) -> Self

Set the working directory.

pub fn term(self, term: impl Into<String>) -> Self

Set the TERM environment variable.

pub fn logging(self, enabled: bool) -> Self

Enable or disable event logging.

Trait Implementations

impl Clone for ShellConfig

fn clone(&self) -> ShellConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShellConfig

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

Formats the value using the given formatter.

impl Default for ShellConfig

fn default() -> Self

Returns the “default value” for a type.