Struct PtySpawnRequest 

pub struct PtySpawnRequest {
    pub argv: Vec<String>,
    pub cwd: Option<PathBuf>,
    pub env: Vec<(String, String)>,
    pub clear_inherited_env: bool,
    pub environment_policy: EnvironmentPolicy,
    pub rows: u16,
    pub cols: u16,
    pub originator: Option<String>,
}

Request shape for spawning a daemon-owned PTY session.

Fields

argv: Vec<String>

Command and arguments to execute inside the PTY.

cwd: Option<PathBuf>

Working directory for the spawned process.

env: Vec<(String, String)>

Explicit environment variables applied after the selected base.

clear_inherited_env: bool

Deprecated wire-compatibility bit. Prefer Self::environment_policy.

environment_policy: EnvironmentPolicy

Base environment used before applying Self::env.

rows: u16

Initial terminal row count.

cols: u16

Initial terminal column count.

originator: Option<String>

Optional caller-defined owner string used for listing and filtering sessions.

Implementations

impl PtySpawnRequest

pub fn new<S: Into<String>>(argv: impl IntoIterator<Item = S>) -> Self

Create a request with default size that snapshots the caller environment and replaces the daemon environment.

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

Set the working directory for the spawned process.

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

Set the initial PTY size.

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

Set the caller-defined owner string for this session.

pub fn with_envs<I, K, V>(self, env: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Replace the request’s explicit environment variables.

pub fn with_environment_policy(self, policy: EnvironmentPolicy) -> Self

Select the base environment for this contained remote child. Auto resolves to the contained-process default, Inherit.

Trait Implementations

impl Clone for PtySpawnRequest

fn clone(&self) -> PtySpawnRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PtySpawnRequest

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

Formats the value using the given formatter.