Struct PtyProcess 

pub struct PtyProcess { /* private fields */ }

A managed PTY process for shell interaction.

Example

use ftui_pty::pty_process::{PtyProcess, ShellConfig};
use std::time::Duration;

let config = ShellConfig::default()
    .inherit_env()
    .size(80, 24);

let mut proc = PtyProcess::spawn(config)?;

// Send a command
proc.write_all(b"echo hello\n")?;

// Read output
let output = proc.read_until(b"hello", Duration::from_secs(5))?;

// Check if still alive
assert!(proc.is_alive());

// Clean termination
proc.kill()?;

Implementations

impl PtyProcess

pub fn spawn(config: ShellConfig) -> Result<Self>

Spawn a new shell process with the given configuration.

Errors

Returns an error if:

• The PTY system cannot be initialized
• The shell executable cannot be found
• The shell fails to start

pub fn is_alive(&mut self) -> bool

Check if the process is still alive.

This method polls the process state and updates internal tracking.

pub fn state(&mut self) -> ProcessState

Get the current process state.

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

Get the process ID, if available.

pub fn kill(&mut self) -> Result<()>

Kill the process.

This method is idempotent - calling it on an already-dead process succeeds.

Errors

Returns an error if the kill signal cannot be sent.

pub fn wait(&mut self) -> Result<ExitStatus>

Wait for the process to exit.

This blocks until the process terminates or the timeout is reached.

Errors

Returns an error if the wait fails or times out.

pub fn wait_timeout(&mut self, timeout: Duration) -> Result<ExitStatus>

Wait for the process to exit with a timeout.

Errors

Returns TimedOut if the timeout is reached before the process exits.

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

Send input to the process.

Errors

Returns an error if the write fails.

pub fn read_available(&mut self) -> Result<Vec<u8>>

Read any available output without blocking.

pub fn read_until( &mut self, pattern: &[u8], timeout: Duration, ) -> Result<Vec<u8>>

Read output until a pattern is found or timeout.

Errors

Returns TimedOut if the pattern is not found within the timeout.

pub fn drain(&mut self, timeout: Duration) -> Result<usize>

Drain all remaining output until EOF or timeout.

pub fn output(&self) -> &[u8]

Get all captured output.

pub fn clear_output(&mut self)

Clear the captured output buffer.

pub fn resize(&mut self, cols: u16, rows: u16) -> Result<()>

Resize the PTY.

This sends SIGWINCH to the child process.

Trait Implementations

impl Debug for PtyProcess

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

Formats the value using the given formatter.

impl Drop for PtyProcess

fn drop(&mut self)

Executes the destructor for this type.