Struct crossterm::TerminalOutput

pub struct TerminalOutput {
    pub is_in_raw_mode: bool,
    // some fields omitted
}

Struct that is an handle to an terminal screen. This handle could be used to write to the current screen

For unix and windows 10 stdout() will be used for handle when on windows systems with versions lower than 10 WinApi HANDLE will be used.

Fields

is_in_raw_mode: bool

Methods

impl TerminalOutput

pub fn new(raw_mode: bool) -> Self

Create new screen write instance whereon screen related actions can be performed.

pub fn write_string(&self, string: String) -> Result<usize>

Write String to the current screen.

pub fn flush(&self) -> Result<()>

Flush the current screen.

pub fn write_str(&self, string: &str) -> Result<usize>

Write &str to the current screen.

pub fn write_buf(&self, buf: &[u8]) -> Result<usize>

Write buffer to the screen

Trait Implementations

impl From<TerminalOutput> for Screen

fn from(stdout: TerminalOutput) -> Self

Create an screen with the given Stdout

impl Default for TerminalOutput

fn default() -> Self

Get the default handle to the current screen.