Struct TerminalHandle 

pub struct TerminalHandle {
    pub state: Arc<Mutex<TerminalState>>,
    /* private fields */
}

Handle to a running terminal session

Fields

state: Arc<Mutex<TerminalState>>

Terminal state (grid, cursor, etc.)

Implementations

impl TerminalHandle

pub fn write(&self, data: &[u8])

Write data to the terminal (sends to PTY)

pub fn resize(&mut self, cols: u16, rows: u16)

Resize the terminal

pub fn is_alive(&self) -> bool

Check if the terminal is still running

pub fn shutdown(&self)

Shutdown the terminal

pub fn pid(&self) -> Option<u32>

Pid of the shell at the head of the pty session, when portable_pty was able to report it. Returns None on platforms / configurations that don’t expose a pid.

pub fn foreground_process_name(&self) -> Option<String>

Name of the command currently in the foreground of this terminal, e.g. "bash" at the prompt or "python3" while a REPL runs.

Derived from the PTY’s foreground process group (tcgetpgrp on the master fd) rather than the shell pid, so it tracks whatever the user is actually interacting with — the same signal tmux uses for #{pane_current_command}. This is how a tab can read python3 even though python3 never emits an OSC title sequence.

Only implemented on Linux (via /proc/<pgid>/comm); returns None elsewhere so callers fall back to the OSC title or default name.

pub fn signal(&self, signal_name: &str) -> Result<bool, String>

Send signal to the terminal’s process group. Returns Ok(false) when the terminal has no recorded pid (Windows, or platforms where portable_pty didn’t report one) — caller can fall back to shutdown() (SIGKILL via child_killer). The shell is always its own session leader inside a pty, so kill(-pid, …) reaches the shell and any subprocesses it forked.

Recognised signal names: "SIGTERM", "SIGKILL", "SIGINT", "SIGHUP". Unknown names return an Err instead of dropping silently.

pub fn size(&self) -> (u16, u16)

Get current dimensions

pub fn cwd(&self) -> Option<PathBuf>

Get the working directory configured for the terminal

pub fn shell(&self) -> &str

Get the shell executable path used for this terminal