Struct CaptureBackend 

pub struct CaptureBackend { /* private fields */ }

A backend that captures output to a buffer

Implementations

impl CaptureBackend

pub fn new(cols: u16, rows: u16) -> Self

Create a new capture backend with the given size

pub fn take_buffer(&mut self) -> Vec<u8>

Take the captured output buffer, leaving an empty buffer

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

Get a reference to the captured output

pub fn clear_buffer(&mut self)

Clear the buffer without returning it

pub fn resize(&mut self, cols: u16, rows: u16)

Resize the backend

pub fn reset_style_state(&mut self)

Reset style state to force full output on next draw Call this when a new client connects to ensure they get a complete frame

Trait Implementations

impl Backend for CaptureBackend

type Error = Error

Error type associated with this Backend.

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

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

Draw the given content to the terminal screen.

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

Hide the cursor on the terminal screen.

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

Show the cursor on the terminal screen.

fn get_cursor_position(&mut self) -> Result<Position>

Get the current cursor position on the terminal screen.

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

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

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

Clears the whole terminal screen

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

Clears a specific region of the terminal specified by the ClearType parameter

fn append_lines(&mut self, n: u16) -> Result<()>

Insert n line breaks to the terminal screen.

fn size(&self) -> Result<Size>

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

fn window_size(&mut self) -> Result<WindowSize>

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

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

Flush any buffered content to the terminal screen.

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.