Enum TermTestError 

pub enum TermTestError {
    Pty(String),
    Io(Error),
    Timeout {
        timeout_ms: u64,
    },
    Parse(String),
    SpawnFailed(String),
    ProcessAlreadyRunning,
    NoProcessRunning,
    InvalidDimensions {
        width: u16,
        height: u16,
    },
}

Errors that can occur during TUI testing.

This enum represents all possible error conditions in the ratatui_testlib library. Each variant provides specific context about the failure.

Variants

• TermTestError::Pty: Low-level PTY operation failures
• TermTestError::Io: Standard I/O errors (file, network, etc.)
• TermTestError::Timeout: Wait operations that exceed their deadline
• TermTestError::Parse: Terminal escape sequence parsing errors
• SnapshotMismatch: Snapshot testing failures (requires snapshot-insta feature)
• SixelValidation: Sixel graphics validation failures (requires sixel feature)
• TermTestError::SpawnFailed: Process spawning failures
• TermTestError::ProcessAlreadyRunning: Attempt to spawn when a process is already running
• TermTestError::NoProcessRunning: Attempt to interact with a non-existent process
• TermTestError::InvalidDimensions: Invalid terminal size parameters
• Bevy: Bevy ECS-related errors (requires bevy feature)

Variants

Pty(String)

Error from PTY (pseudo-terminal) operations.

This error occurs when low-level PTY operations fail, such as:

• PTY allocation failures
• PTY configuration errors
• PTY system unavailability

Io(Error)

Standard I/O error.

This wraps std::io::Error and occurs for file operations, network I/O, or other system-level I/O failures. Automatically converted via From trait.

Timeout

Timeout waiting for a condition.

This error is returned when a wait operation (like TuiTestHarness::wait_for) exceeds its configured timeout duration. The error includes the timeout value for debugging purposes.

Example

use ratatui_testlib::{TuiTestHarness, TermTestError};
use std::time::Duration;

let mut harness = TuiTestHarness::new(80, 24)?
    .with_timeout(Duration::from_secs(1));

match harness.wait_for_text("Never appears") {
    Err(TermTestError::Timeout { timeout_ms }) => {
        eprintln!("Timed out after {}ms", timeout_ms);
    }
    _ => {}
}

Fields

timeout_ms: u64

Timeout duration in milliseconds.

Parse(String)

Error parsing terminal escape sequences.

This occurs when the terminal emulator encounters malformed or unexpected escape sequences in the PTY output.

SpawnFailed(String)

Process spawn failed.

This error occurs when attempting to spawn a process in the PTY fails, typically due to:

• Command not found
• Permission denied
• Resource limits exceeded

ProcessAlreadyRunning

Process already running.

This error is returned when attempting to spawn a process while another process is still running in the PTY. Only one process can run at a time in a given TestTerminal.

NoProcessRunning

No process running.

This error occurs when attempting to interact with a process (e.g., wait, kill) when no process is currently running in the PTY.

InvalidDimensions

Invalid terminal dimensions.

This error is returned when attempting to create or resize a terminal with invalid dimensions (e.g., zero width or height, or dimensions that exceed system limits).

Fields

width: u16

Terminal width in columns.

height: u16

Terminal height in rows.

Trait Implementations

impl Debug for TermTestError

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

Formats the value using the given formatter.

impl Display for TermTestError

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

Formats the value using the given formatter.

impl Error for TermTestError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<Error> for TermTestError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for TermTestError

fn from(err: Error) -> Self

Converts to this type from the input type.