Struct NativePtyProcess 

pub struct NativePtyProcess {

    pub argv: Vec<String>,
    pub cwd: Option<String>,
    pub env: Option<Vec<(String, String)>>,
    pub rows: u16,
    pub cols: u16,
    pub handles: Arc<Mutex<Option<NativePtyHandles>>>,
    pub reader: Arc<PtyReadShared>,
    pub returncode: Arc<Mutex<Option<i32>>>,
    pub input_bytes_total: Arc<AtomicUsize>,
    pub newline_events_total: Arc<AtomicUsize>,
    pub submit_events_total: Arc<AtomicUsize>,
    pub echo: Arc<AtomicBool>,
    pub idle_detector: Arc<Mutex<Option<Arc<IdleDetectorCore>>>>,
    pub output_bytes_total: Arc<AtomicUsize>,
    pub control_churn_bytes_total: Arc<AtomicUsize>,
    pub reader_worker: Mutex<Option<JoinHandle<()>>>,
    pub terminal_input_relay_stop: Arc<AtomicBool>,
    pub terminal_input_relay_active: Arc<AtomicBool>,
    pub terminal_input_relay_worker: Mutex<Option<JoinHandle<()>>>,
}

Re-exported native PTY process and interactive session types. Low-level native pseudo-terminal process wrapper.

The process is configured at construction time and is spawned by Self::start_impl. Output is collected by a reader thread and exposed through the chunk-reading methods.

Fields

argv: Vec<String>

Command argv, including the executable as the first element.

cwd: Option<String>

Working directory used when spawning the child, or the current directory.

env: Option<Vec<(String, String)>>

Environment overrides passed to the child process.

rows: u16

Initial PTY row count.

cols: u16

Initial PTY column count.

handles: Arc<Mutex<Option<NativePtyHandles>>>

Native PTY handles for the running child, present after start.

reader: Arc<PtyReadShared>

Shared reader queue and condition variable for PTY output.

returncode: Arc<Mutex<Option<i32>>>

Cached child exit code once the process has exited.

input_bytes_total: Arc<AtomicUsize>

Total bytes written to the PTY input stream.

newline_events_total: Arc<AtomicUsize>

Count of input writes containing a newline.

submit_events_total: Arc<AtomicUsize>

Count of explicit submit events recorded for PTY input.

echo: Arc<AtomicBool>

When true, the reader thread writes PTY output to stdout.

idle_detector: Arc<Mutex<Option<Arc<IdleDetectorCore>>>>

When set, the reader thread feeds output directly to the idle detector.

output_bytes_total: Arc<AtomicUsize>

Visible (non-control) output bytes seen by the reader thread.

control_churn_bytes_total: Arc<AtomicUsize>

Control churn bytes (ANSI escapes, BS, CR, DEL) seen by the reader.

reader_worker: Mutex<Option<JoinHandle<()>>>

Background worker that drains PTY output into the shared queue.

terminal_input_relay_stop: Arc<AtomicBool>

Stop flag observed by the terminal input relay worker.

terminal_input_relay_active: Arc<AtomicBool>

Whether the terminal input relay worker is currently active.

terminal_input_relay_worker: Mutex<Option<JoinHandle<()>>>

Background worker that forwards local terminal input into the PTY.

Implementations

impl NativePtyProcess

pub fn new( argv: Vec<String>, cwd: Option<String>, env: Option<Vec<(String, String)>>, rows: u16, cols: u16, nice: Option<i32>, ) -> Result<Self, PtyError>

Create a pseudo-terminal process configuration.

The child is not spawned until Self::start_impl is called.

pub fn mark_reader_closed(&self)

Mark the reader stream closed and wake all waiting readers.

pub fn store_returncode(&self, code: i32)

Store the process return code if it has been observed.

pub fn record_input_metrics(&self, data: &[u8], submit: bool)

Record PTY input byte, newline, and submit counters.

pub fn write_impl(&self, data: &[u8], submit: bool) -> Result<(), PtyError>

Write bytes to the PTY input stream and record input metrics.

pub fn request_terminal_input_relay_stop(&self)

Signal the terminal input relay worker to stop.

pub fn start_terminal_input_relay_impl(&self) -> Result<(), PtyError>

Start forwarding local terminal input into the PTY.

pub fn stop_terminal_input_relay_impl(&self)

Stop the terminal input relay worker and wait for it to exit.

pub fn terminal_input_relay_active(&self) -> bool

Return whether the terminal input relay worker is active.

pub fn close_impl(&self) -> Result<(), PtyError>

Synchronously tear down the PTY and reap the child.

pub fn close_nonblocking(&self)

Best-effort, non-blocking teardown for use from Drop.

pub fn start_impl(&self) -> Result<(), PtyError>

Spawn the configured child process inside a native PTY.

pub fn respond_to_queries_impl(&self, data: &[u8]) -> Result<(), PtyError>

Respond to terminal query escape sequences found in a PTY output chunk.

pub fn resize_impl(&self, rows: u16, cols: u16) -> Result<(), PtyError>

Resize the PTY to the given row and column dimensions.

pub fn send_interrupt_impl(&self) -> Result<(), PtyError>

Send an interrupt signal or control event to the PTY child.

pub fn wait_impl(&self, timeout: Option<f64>) -> Result<i32, PtyError>

Wait for the PTY child to exit and return its exit code.

Returns a timeout error when timeout elapses before exit.

pub fn terminate_impl(&self) -> Result<(), PtyError>

Request graceful termination of the PTY child.

pub fn kill_impl(&self) -> Result<(), PtyError>

Forcefully terminate the PTY child.

pub fn terminate_tree_impl(&self) -> Result<(), PtyError>

Request graceful termination of the PTY child process tree.

pub fn kill_tree_impl(&self) -> Result<(), PtyError>

Forcefully terminate the PTY child process tree.

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

Get the PID of the child process, if running.

pub fn read_chunk_impl( &self, timeout: Option<f64>, ) -> Result<Option<Vec<u8>>, PtyError>

Wait for a chunk of output from the PTY reader. Returns Ok(Some(chunk)) on data, Ok(None) on timeout, Err on closed.

pub fn wait_for_reader_closed_impl(&self, timeout: Option<f64>) -> bool

Wait for the reader thread to close.

pub fn wait_and_drain_impl( &self, timeout: Option<f64>, drain_timeout: f64, ) -> Result<i32, PtyError>

Wait for exit then drain remaining output.

pub fn set_echo(&self, enabled: bool)

Enable or disable echoing PTY output to stdout.

pub fn echo_enabled(&self) -> bool

Return whether PTY output echoing is enabled.

pub fn attach_idle_detector(&self, detector: &Arc<IdleDetectorCore>)

Attach an idle detector that observes reader-thread output.

pub fn detach_idle_detector(&self)

Detach the current idle detector, if one is attached.

pub fn pty_input_bytes_total(&self) -> usize

Return total bytes written to PTY input.

pub fn pty_newline_events_total(&self) -> usize

Return the number of PTY input writes containing newlines.

pub fn pty_submit_events_total(&self) -> usize

Return the number of recorded PTY input submit events.

pub fn pty_output_bytes_total(&self) -> usize

Return visible PTY output bytes observed by the reader thread.

pub fn pty_control_churn_bytes_total(&self) -> usize

Return control-churn bytes observed by the reader thread.

Trait Implementations

impl Drop for NativePtyProcess

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.