Struct TestBackend 

pub struct TestBackend { /* private fields */ }

A test backend for unit testing and snapshot testing.

Records operations and maintains a virtual terminal buffer.

Example

use tuxtui_core::backend::{Backend, TestBackend};
use tuxtui_core::geometry::Rect;

let mut backend = TestBackend::new(80, 24);
backend.clear().unwrap();
let size = backend.size().unwrap();
assert_eq!(size.width, 80);
assert_eq!(size.height, 24);

Implementations

impl TestBackend

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

Create a new test backend with the given dimensions.

pub fn buffer(&self) -> &Buffer

Get the current buffer content.

pub fn buffer_mut(&mut self) -> &mut Buffer

Get a mutable reference to the buffer.

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

Resize the test backend.

pub const fn is_cursor_visible(&self) -> bool

Get the cursor visibility state.

pub fn assert_buffer_equals(&self, expected: &str)

Assert that the buffer contains the expected string at the given position.

Panics

Panics if the buffer content doesn’t match.

Trait Implementations

impl Backend for TestBackend

type Error = TestBackendError

The error type for this backend.

fn size(&self) -> Result<Rect, Self::Error>

Get the size of the terminal in columns and rows.

fn clear(&mut self) -> Result<(), Self::Error>

Clear the entire screen.

fn clear_region(&mut self, region: Rect) -> Result<(), Self::Error>

Clear a specific region.

fn hide_cursor(&mut self) -> Result<(), Self::Error>

Hide the cursor.

fn show_cursor(&mut self) -> Result<(), Self::Error>

Show the cursor.

fn get_cursor(&mut self) -> Result<Position, Self::Error>

Get the current cursor position.

fn set_cursor(&mut self, x: u16, y: u16) -> Result<(), Self::Error>

Set the cursor position.

fn draw_cell(&mut self, x: u16, y: u16, cell: &Cell) -> Result<(), Self::Error>

Draw a single cell at the given position.

fn set_style(&mut self, _style: Style) -> Result<(), Self::Error>

Set the current style for subsequent operations.

fn reset_style(&mut self) -> Result<(), Self::Error>

Reset all styling to default.

fn flush(&mut self) -> Result<(), Self::Error>

Flush any buffered output to the terminal.

fn enable_raw_mode(&mut self) -> Result<(), Self::Error>

Enable raw mode.

fn disable_raw_mode(&mut self) -> Result<(), Self::Error>

Disable raw mode.

fn enter_alternate_screen(&mut self) -> Result<(), Self::Error>

Enter alternate screen.

fn leave_alternate_screen(&mut self) -> Result<(), Self::Error>

Leave alternate screen.

fn set_scroll_region( &mut self, top: u16, bottom: u16, ) -> Result<(), Self::Error>

Available on crate feature scrolling-regions only.

Enable mouse capture (if supported).

fn clear_scroll_region(&mut self) -> Result<(), Self::Error>

Available on crate feature scrolling-regions only.

Clear scroll region (if supported).