Struct crossterm::TerminalOutput

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

Struct that is a handle to the current terminal screen.

For UNIX and Windows 10 stdout() will be used as handle. And for Windows systems, not supporting ANSI escape codes, will use WinApi's HANDLE as handle.

Fields

is_in_raw_mode: bool

checks if this output is in raw mode.

Methods

impl TerminalOutput

Important traits for TerminalOutput

impl Write for TerminalOutput

pub fn new(raw_mode: bool) -> TerminalOutput

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

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

Write String to the current screen.

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

Flush the current screen.

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

Write &str to the current screen.

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

Write buffer to the screen

Trait Implementations

impl Write for TerminalOutput

fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Write a buffer into this writer, returning how many bytes were written.

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

default fn write_vectored(&mut self, bufs: &[IoVec]) -> Result<usize, Error>

🔬 This is a nightly-only experimental API. (iovec)

Like write, except that it writes from a slice of buffers.

default fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

default fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

default fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.

impl Default for TerminalOutput

Important traits for TerminalOutput

impl Write for TerminalOutput

fn default() -> TerminalOutput

Get the default handle to the current screen.

impl From<TerminalOutput> for Screen

Important traits for Screen

impl Write for Screen

fn from(stdout: TerminalOutput) -> Screen

Create a screen with the given Stdout