Struct MockTty 

pub struct MockTty { /* private fields */ }

Mock TTY backend that captures output and tracks terminal state.

This struct allows testing terminal applications without a real TTY by:

• Capturing all output (including ANSI escape sequences)
• Tracking terminal state (raw mode, alternate screen, etc.)
• Providing mock events for input simulation

Implementations

impl MockTty

pub fn new(width: u16, height: u16) -> Self

Create a new mock TTY with the given dimensions.

pub fn with_events(self, events: Vec<Event>) -> Self

Queue events to be returned by read_event().

pub fn with_polls(self, polls: Vec<bool>) -> Self

Queue poll results to be returned by poll().

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

Get the terminal size.

pub fn set_size(&mut self, width: u16, height: u16)

Set the terminal size (for resize simulation).

pub fn is_raw_mode(&self) -> bool

Check if raw mode is enabled.

pub fn enable_raw_mode(&mut self)

Enable raw mode.

pub fn disable_raw_mode(&mut self)

Disable raw mode.

pub fn is_alternate_screen(&self) -> bool

Check if alternate screen is active.

pub fn enter_alternate_screen(&mut self)

Enter alternate screen.

pub fn leave_alternate_screen(&mut self)

Leave alternate screen.

pub fn is_cursor_visible(&self) -> bool

Check if cursor is visible.

pub fn hide_cursor(&mut self)

Hide cursor.

pub fn show_cursor(&mut self)

Show cursor.

pub fn is_mouse_captured(&self) -> bool

Check if mouse capture is enabled.

pub fn enable_mouse_capture(&mut self)

Enable mouse capture.

pub fn disable_mouse_capture(&mut self)

Disable mouse capture.

pub fn poll(&mut self, _timeout: Duration) -> Result<bool>

Poll for events with timeout.

pub fn read_event(&mut self) -> Result<Event>

Read the next event.

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

Get the captured output bytes.

pub fn output_str(&self) -> String

Get the captured output as a string (lossy UTF-8 conversion).

pub fn clear_output(&mut self)

Clear the captured output.

pub fn output_contains(&self, needle: &[u8]) -> bool

Check if the output contains a specific byte sequence. Returns false for empty needle (consistent with windows(0) behavior).

pub fn output_contains_str(&self, needle: &str) -> bool

Check if the output contains a specific string.

pub fn contains_escape(&self, seq: &str) -> bool

Check if the output contains an ANSI escape sequence.

pub fn parsed_commands(&self) -> Vec<AnsiCommand>

Parse output into ANSI commands.

pub fn queued_events(&self) -> usize

Get the number of queued events.

pub fn push_event(&mut self, event: Event)

Add an event to the queue.

pub fn push_poll(&mut self, result: bool)

Add a poll result to the queue.

Trait Implementations

impl Debug for MockTty

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

Formats the value using the given formatter.

impl Default for MockTty

fn default() -> Self

Returns the “default value” for a type.

impl Write for MockTty

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.