Struct PtyConfig 

#[non_exhaustive]
pub struct PtyConfig {
    pub dimensions: (u16, u16),
    pub login_shell: bool,
    pub env_mode: EnvMode,
    pub env: HashMap<String, String>,
    pub working_directory: Option<PathBuf>,
}

Configuration for PTY spawning.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

dimensions: (u16, u16)

Terminal dimensions (cols, rows).

login_shell: bool

Whether to use a login shell.

env_mode: EnvMode

Environment variable handling.

env: HashMap<String, String>

Environment variables to apply per env_mode (overlay for Extend, the full set for Clear, ignored for Inherit).

working_directory: Option<PathBuf>

Working directory for the spawned child. None inherits the parent’s current directory.

Trait Implementations

impl Clone for PtyConfig

fn clone(&self) -> PtyConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PtyConfig

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

Formats the value using the given formatter.

impl Default for PtyConfig

fn default() -> Self

Returns the “default value” for a type.

impl From<&SessionConfig> for PtyConfig

fn from(config: &SessionConfig) -> Self

Converts to this type from the input type.