Struct textmode::blocking::Output

pub struct Output { /* private fields */ }

Manages drawing to the terminal on stdout.

Most functionality is provided by the Textmode trait. You should call those trait methods to draw to the in-memory screen, and then call refresh when you want to update the terminal on stdout.

Implementations

impl Output

pub fn new() -> Result<Self>

Creates a new Output instance containing a ScreenGuard instance.

Errors

• Error::WriteStdout: failed to write initialization to stdout

pub fn new_without_screen() -> Self

Creates a new Output instance without creating a ScreenGuard instance.

pub fn take_screen_guard(&mut self) -> Option<ScreenGuard>

Removes the ScreenGuard instance stored in this Output instance and returns it. This can be useful if you need to manage the lifetime of the ScreenGuard instance separately.

pub fn refresh(&mut self) -> Result<()>

Draws the in-memory screen to the terminal on stdout. This is done using a diff mechanism to only update the parts of the terminal which are different from the in-memory screen.

Errors

• Error::WriteStdout: failed to write screen state to stdout

pub fn hard_refresh(&mut self) -> Result<()>

Draws the in-memory screen to the terminal on stdout. This clears the screen and redraws it from scratch, rather than using a diff mechanism like refresh. This can be useful when the current state of the terminal screen is unknown, such as after the terminal has been resized.

Errors

• Error::WriteStdout: failed to write screen state to stdout

Trait Implementations

impl Textmode for Output

fn screen(&self) -> &Screen

Returns the in-memory screen itself. This is the screen that will be drawn on the next call to refresh.

fn write(&mut self, buf: &[u8])

Writes a sequence of bytes, potentially containing terminal escape sequences, to the in-memory screen.

fn set_size(&mut self, rows: u16, cols: u16)

Sets the terminal size for the in-memory screen.

fn write_str(&mut self, text: &str)

Writes a string of printable characters to the in-memory screen.

fn move_to(&mut self, row: u16, col: u16)

Moves the in-memory screen’s cursor.

fn move_relative(&mut self, row_offset: i16, col_offset: i16)

fn clear(&mut self)

Clears the in-memory screen.

fn clear_line(&mut self)

Clears the line containing the cursor on the in-memory screen.

fn reset_attributes(&mut self)

Clears the in-memory screen’s currently active drawing attributes.

fn set_fgcolor(&mut self, color: Color)

Sets the foreground color for subsequent drawing operations to the in-memory screen.

fn set_bgcolor(&mut self, color: Color)

Sets the background color for subsequent drawing operations to the in-memory screen.

fn set_bold(&mut self, bold: bool)

Sets whether subsequent text drawn to the in-memory screen should be bold.

fn set_italic(&mut self, italic: bool)

Sets whether subsequent text drawn to the in-memory screen should be italic.

fn set_underline(&mut self, underline: bool)

Sets whether subsequent text drawn to the in-memory screen should be underlined.

fn set_inverse(&mut self, inverse: bool)

Sets whether subsequent text drawn to the in-memory screen should have its colors inverted.

fn hide_cursor(&mut self, hide: bool)

Sets whether the cursor should be visible.