Struct PtySpawnConfig

pub struct PtySpawnConfig {
    pub program: Option<PathBuf>,
    pub args: Vec<String>,
    pub cwd: Option<PathBuf>,
    pub env: Vec<(String, String)>,
    pub term: String,
    pub size: PtySize,
}

Backend-neutral child process and PTY spawn configuration.

Values are not validated. For the portable backend, program == None selects the library’s platform-default program and ignores args; an explicit program receives arguments in order. cwd and environment entries are passed to the backend. The portable backend sets TERM from term first and then applies env, so a later ("TERM", value) entry can override it; duplicate-variable behavior otherwise follows the backend/OS.

Examples

use std::path::PathBuf;
use ailloli_ui_terminal_pty::{PtySize, PtySpawnConfig};
let config = PtySpawnConfig {
    program: Some(PathBuf::from("sh")),
    args: vec!["-lc".into(), "printf ok".into()],
    size: PtySize::new(30, 100, 0, 0),
    ..PtySpawnConfig::default()
};
assert_eq!(config.args.len(), 2);

Fields

program: Option<PathBuf>

Explicit program path/name, or None for the backend default.

args: Vec<String>

Ordered arguments used only with an explicit program by the portable backend.

cwd: Option<PathBuf>

Child working directory, or None to inherit backend behavior.

env: Vec<(String, String)>

Ordered environment overrides; names/values may be empty or duplicated.

term: String

Requested TERM value; stored/passed verbatim and empty is accepted.

size: PtySize

Initial PTY grid and pixel dimensions.

Trait Implementations

impl Clone for PtySpawnConfig

fn clone(&self) -> PtySpawnConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PtySpawnConfig

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

Formats the value using the given formatter.

impl Default for PtySpawnConfig

fn default() -> Self

Selects the default program, no args/CWD/env, xterm-256color, and 24x80.

Examples

use ailloli_ui_terminal_pty::PtySpawnConfig;
let config = PtySpawnConfig::default();
assert!(config.program.is_none() && config.args.is_empty());
assert_eq!(config.term, "xterm-256color");

impl<'de> Deserialize<'de> for PtySpawnConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PtySpawnConfig

fn eq(&self, other: &PtySpawnConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PtySpawnConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PtySpawnConfig

impl StructuralPartialEq for PtySpawnConfig