Struct InstrumentedBackend 

pub struct InstrumentedBackend { /* private fields */ }

Implementations

impl InstrumentedBackend

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

pub fn take_events(&mut self) -> Vec<BackendEvent>

pub fn take_stats(&mut self) -> BackendStats

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

pub fn buffer(&self) -> &Buffer

pub fn scrollback(&self) -> &Buffer

Trait Implementations

impl Backend for InstrumentedBackend

type Error = !

Error type associated with this Backend.

fn draw<'a, I>(&mut self, content: I) -> Result<(), Self::Error>

where I: Iterator<Item = (u16, u16, &'a Cell)>,

Draw the given content to the terminal screen.

fn append_lines(&mut self, lines: u16) -> Result<(), Self::Error>

Insert n line breaks to the terminal screen.

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

Hide the cursor on the terminal screen.

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

Show the cursor on the terminal screen.

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

Get the current cursor position on the terminal screen.

fn set_cursor_position<P: Into<Position>>( &mut self, position: P, ) -> Result<(), Self::Error>

Set the cursor position on the terminal screen to the given x and y coordinates.

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

Clears all character cells in the terminal’s visible display area.

fn clear_region(&mut self, clear_type: ClearType) -> Result<(), Self::Error>

Clears a specific region of the terminal’s visible display area, as defined by ClearType.

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

Get the size of the terminal screen in columns/rows as a Size.

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

Get the size of the terminal screen in columns/rows and pixels as a WindowSize.

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

Flush any backend-buffered output to the terminal screen.

fn scroll_region_up( &mut self, region: Range<u16>, lines: u16, ) -> Result<(), Self::Error>

Scroll a region of the screen upwards, where a region is specified by a (half-open) range of rows.

fn scroll_region_down( &mut self, region: Range<u16>, lines: u16, ) -> Result<(), Self::Error>

Scroll a region of the screen downwards, where a region is specified by a (half-open) range of rows.

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

👎Deprecated:

use get_cursor_position() instead which returns Result<Position>

Get the current cursor position on the terminal screen.

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

👎Deprecated:

use set_cursor_position((x, y)) instead which takes impl Into<Position>

Set the cursor position on the terminal screen to the given x and y coordinates.

impl Borrow<TestBackend> for InstrumentedBackend

fn borrow(&self) -> &TestBackend

Immutably borrows from an owned value.

impl Debug for InstrumentedBackend

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

Formats the value using the given formatter.