Struct tanmatsu::Terminal

pub struct Terminal<'a> {
    pub stdout: BufWriter<StdoutLock<'a>>,
    pub size: Size,
    pub flush_count: usize,
    // some fields omitted
}

Fields

stdout: BufWriter<StdoutLock<'a>>

size: Size

flush_count: usize

Implementations

impl<'a> Terminal<'a>

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 reset_cursor(&mut self)

Sets the cursor to the top left corner.

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

Sets the cursor to point.

If possible, try to use the move_cursor_{}_by and move_cursor_{} methods instead for single operations.

pub fn set_cursor_x(&mut self, x: u16)

Sets the cursor X-coordinate to x.

pub fn set_cursor_y(&mut self, y: u16)

Sets the cursor Y-coordinate to y.

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

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

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

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

pub fn move_cursor_up(&mut self)

pub fn move_cursor_down(&mut self)

pub fn move_cursor_left(&mut self)

pub fn move_cursor_right(&mut self)

pub fn next_line(&mut self)

pub fn previous_line(&mut self)

pub fn save_cursor_point(&mut self)

pub fn restore_cursor_point(&mut self)

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

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

pub fn change_foreground_color(&mut self, hex_color: &str)

Changes the terminal’s foreground text color to hex_color.

hex_color must be a hexadecimal color such as "FF0000".

pub fn reset_foreground_color(&mut self)

pub fn change_background_color(&mut self, hex_color: &str)

Changes the terminal’s background text color to hex_color.

hex_color must be a hexadecimal color such as FF0000.

pub fn reset_background_color(&mut self)

pub fn change_cursor_color(&mut self, hex_color: &str)

Changes the terminal’s cursor color to hex_color.

hex_color must be a hexadecimal color such as FF0000.

pub fn reset_cursor_color(&mut self)

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)

impl<'a> Terminal<'a>

A terminal with an io::Stdout inside.

Every program can have only a single instance for writing. The standard output stream is locked and no other instance can write.

pub fn new(stdout: StdoutLock<'a>) -> 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 initialize(&mut self, title: Option<&str>, with_mouse: bool)

Makes this terminal suitable for drawing and input.

Note that this does not do anything until [flush] is used.

pub fn deinitialize(&mut self)

Deinitializes the terminal back into its normal state.

Note that this does not do anything until [flush] is used.

pub fn contains(&self, point: Point) -> bool

Trait Implementations

impl<'a> Debug for Terminal<'a>

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

Formats the value using the given formatter.