Enum ExpectError 

#[non_exhaustive]
pub enum ExpectError {
    ScreenNotAttached,
    InvalidInput {
        api: String,
        reason: String,
    },
    Spawn(SpawnError),
    Io(Error),
    IoWithContext {
        context: String,
        source: Error,
    },
    Timeout {
        duration: Duration,
        pattern: String,
        buffer: String,
    },
    PatternNotFound {
        pattern: String,
        buffer: String,
    },
    ProcessExited {
        exit_status: ExitStatus,
        buffer: String,
    },
    Eof {
        buffer: String,
    },
    InvalidPattern {
        message: String,
    },
    Regex(Error),
    SessionClosed,
    SessionNotFound {
        id: usize,
    },
    NoSessions,
    MultiSessionError {
        session_id: usize,
        error: Box<Self>,
    },
    NotInteracting,
    BufferOverflow {
        max_size: usize,
    },
    Encoding {
        message: String,
    },
    Config {
        message: String,
    },
    Signal {
        message: String,
    },
}

The main error type for rust-expect operations.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ScreenNotAttached

A screen-aware operation was called without a screen attached.

Indicates a programmer error rather than a runtime miss: the caller invoked expect_screen_contains, wait_screen_not_contains, or wait_screen_stable without first calling Session::attach_screen.

InvalidInput

Caller-supplied input was rejected before any I/O happened.

Used by APIs that validate their input — for example, send_paste refuses payloads containing the bracketed-paste end marker because they would let the receiver drop out of paste mode mid-stream. The reason is a short human-readable explanation suitable for surfacing in a test failure or log line.

Fields

api: String

Name of the API that rejected the input (e.g. "send_paste").

reason: String

Human-readable explanation of why the input was rejected.

Spawn(SpawnError)

Failed to spawn a process.

Io(Error)

An I/O error occurred.

IoWithContext

An I/O error occurred with additional context.

Fields

context: String

What operation was being performed.

source: Error

The underlying I/O error.

Timeout

Timeout waiting for pattern match.

Fields

duration: Duration

The timeout duration that elapsed.

pattern: String

The pattern that was being searched for.

buffer: String

Buffer contents at the time of timeout.

PatternNotFound

Pattern was not found before EOF.

Fields

pattern: String

The pattern that was being searched for.

buffer: String

Buffer contents when EOF was reached.

ProcessExited

Process exited unexpectedly.

Fields

exit_status: ExitStatus

The exit status of the process.

buffer: String

Buffer contents when process exited.

Eof

End of file reached.

Fields

buffer: String

Buffer contents when EOF was reached.

InvalidPattern

Invalid pattern specification.

Fields

message: String

Description of what’s wrong with the pattern.

Regex(Error)

Invalid regex pattern.

SessionClosed

Session is closed.

SessionNotFound

Session not found.

Fields

id: usize

The session ID that was not found.

NoSessions

No sessions available for operation.

MultiSessionError

Error in multi-session operation.

Fields

session_id: usize

The session that encountered the error.

error: Box<Self>

The underlying error.

NotInteracting

Session is not in interact mode.

BufferOverflow

Buffer overflow.

Fields

max_size: usize

The maximum buffer size that was exceeded.

Encoding

Encoding error.

Fields

message: String

Description of the encoding error.

Config

Configuration error.

Fields

message: String

Description of the configuration error.

Signal

Signal error (Unix only).

Fields

message: String

Description of the signal error.

Implementations

impl ExpectError

pub fn timeout( duration: Duration, pattern: impl Into<String>, buffer: impl Into<String>, ) -> Self

Create a timeout error with the given details.

pub fn pattern_not_found( pattern: impl Into<String>, buffer: impl Into<String>, ) -> Self

Create a pattern not found error.

pub fn process_exited( exit_status: ExitStatus, buffer: impl Into<String>, ) -> Self

Create a process exited error.

pub fn eof(buffer: impl Into<String>) -> Self

Create an EOF error.

pub fn invalid_pattern(message: impl Into<String>) -> Self

Create an invalid pattern error.

pub const fn buffer_overflow(max_size: usize) -> Self

Create a buffer overflow error.

pub fn encoding(message: impl Into<String>) -> Self

Create an encoding error.

pub fn config(message: impl Into<String>) -> Self

Create a configuration error.

pub fn io_context(context: impl Into<String>, source: Error) -> Self

Create an I/O error with context.

pub fn with_io_context<T>( result: Result<T>, context: impl Into<String>, ) -> Result<T>

Wrap an I/O result with context.

pub const fn is_timeout(&self) -> bool

Check if this is a timeout error.

pub const fn is_eof(&self) -> bool

Check if this is an EOF error.

pub fn buffer(&self) -> Option<&str>

Get the buffer contents if this error contains them.

Trait Implementations

impl Debug for ExpectError

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

Formats the value using the given formatter.

impl Display for ExpectError

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

Formats the value using the given formatter.

impl Error for ExpectError

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 ExpectError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ExpectError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<SpawnError> for ExpectError

fn from(source: SpawnError) -> Self

Converts to this type from the input type.