Enum TermBackend

pub enum TermBackend {
    Crossterm(CrosstermBackend<Stderr>),
    Test {
        backend: TestBackend,
        events: Vec<Event>,
    },
}

Variants

Crossterm(CrosstermBackend<Stderr>)

Test

Fields

backend: TestBackend

events: Vec<Event>

Implementations

impl TermBackend

pub fn enter_alternate_screen(&mut self) -> Res<()>

pub fn enable_raw_mode(&self) -> Res<()>

pub fn disable_raw_mode(&self) -> Res<()>

pub fn poll_event(&self, timeout: Duration) -> Res<bool>

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

Trait Implementations

impl Backend for TermBackend

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 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 append_lines(&mut self, _n: u16) -> Result<(), Error>

Insert n line breaks to the terminal screen.

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

👎Deprecated: the method get_cursor_position indicates more clearly what about the cursor to get

Get the current cursor position on the terminal screen.

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

👎Deprecated: the method set_cursor_position indicates more clearly what about the cursor to set

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

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

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