Struct bo::terminal::Terminal

pub struct Terminal {
    _stdout: AlternateScreen<MouseTerminal<RawTerminal<Stdout>>>,
    stdin_event_stream: Events<Stdin>,
}

Fields

_stdout: AlternateScreen<MouseTerminal<RawTerminal<Stdout>>>

stdin_event_stream: Events<Stdin>

Implementations

impl Terminal

pub fn default() -> Result<Self, Error>

Errors

will return an error if the terminal size can’t be acquired or if the stdout cannot be put into raw mode.

Trait Implementations

impl Console for Terminal

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

Errors

Returns an error if stdout can’t be flushed

fn read_event(&mut self) -> Result<Event, Error>

Errors

Returns an error if a event can’t be read

fn clear_screen(&self)

fn clear_current_line(&self)

fn hide_cursor(&self)

fn show_cursor(&self)

fn set_bg_color(&self, color: Rgb)

fn reset_bg_color(&self)

fn set_fg_color(&self, color: Rgb)

fn reset_fg_color(&self)

fn to_alternate_screen(&self)

fn to_main_screen(&self)

fn clear_all(&self)

fn size(&self) -> ConsoleSize

fn text_area_size(&self) -> ConsoleSize

fn middle_of_screen_line_number(&self) -> LineNumber

fn bottom_of_screen_line_number(&self) -> LineNumber

fn set_cursor_position_in_text_area(
    &self,
    position: &Position,
    row_prefix_length: u8
)

fn set_cursor_position_anywhere(&self, position: &Position)

fn get_cursor_index_from_mouse_event(
    &self,
    mouse_event: MouseEvent,
    row_prefix_length: u8
) -> Position

fn set_cursor_as_steady_bar(&self)

fn set_cursor_as_steady_block(&self)

impl Debug for Terminal

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

Formats the value using the given formatter.