Struct tanmatsu::Terminal

pub struct Terminal {
    pub stdout: Stdout,
    pub size: Size,
    pub flush_count: usize,
    // some fields omitted
}

Fields

stdout: Stdout

size: Size

flush_count: usize

Implementations

impl Terminal

pub fn enter_alternate_dimension(&mut self)

pub fn exit_alternate_dimension(&mut self)

pub fn set_title(&mut self, title: &str)

pub fn enable_raw_mode(&self)

pub fn disable_raw_mode(&self)

pub fn enable_mouse_capture(&mut self)

pub fn disable_mouse_capture(&mut self)

pub fn show_cursor(&mut self)

pub fn hide_cursor(&mut self)

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

Reads an event. It also sets the new size if the terminal has been resized, hence a mutable borrow of self is required.

pub fn poll_event(&mut self, timeout: Duration) -> Option<Event>

pub fn set_cursor(&mut self, point: Point)

pub fn move_cursor_left(&mut self, cells: u16)

pub fn move_cursor_right(&mut self, cells: u16)

pub fn move_cursor_up(&mut self, cells: u16)

pub fn move_cursor_down(&mut self, cells: u16)

pub fn save_cursor_point(&mut self)

pub fn restore_cursor_point(&mut self)

pub fn save_cursor_x(&mut self)

pub fn restore_cursor_y(&mut self)

pub fn set_foreground_color(&mut self, color: Color)

pub fn set_background_color(&mut self, color: Color)

pub fn enable_italic(&mut self)

pub fn disable_italic(&mut self)

pub fn reset_colors(&mut self)

pub fn clear(&mut self)

pub fn clear_from_cursor_to_end(&mut self)

pub fn size() -> Size

impl Terminal

A terminal with an io::Stdout inside.

Optimally every program should have a single instance.

pub fn new() -> Result<Self, NotTTY>

pub fn write(&mut self, string: &str)

pub fn write_bytes(&mut self, bytes: &[u8])

pub fn flush(&mut self)

pub fn get_centered_border_point(&self, size: &Size) -> Point

pub fn get_center(&self) -> Point

pub fn initialize(&mut self)

Makes the terminal ready for drawing and input and registers a panic hook that makes sure [deinitialize] is called before the panic output.

pub fn deinitialize(&mut self)