Struct AlternateScreen

pub struct AlternateScreen<W: ConsoleWrite> { /* private fields */ }

A terminal restorer, which wraps a type implementing Write, and causes all writes to be written to an alternate screen.

This is achieved by switching the terminal to the alternate screen on creation and automatically switching it back to the original screen on drop.

Implementations

impl<W: ConsoleWrite> AlternateScreen<W>

pub fn from(output: W) -> Self

Create an alternate screen wrapper struct for the provided output and switch the terminal to the alternate screen.

Trait Implementations

impl<W: ConsoleWrite> ConsoleWrite for AlternateScreen<W>

fn set_raw_mode(&mut self, mode: bool) -> Result<bool>

Switch the raw mode, true enters raw mode and false exits raw mode.

fn is_raw_mode(&self) -> bool

True if in raw mode.

impl<W: ConsoleWrite> DerefMut for AlternateScreen<W>

fn deref_mut(&mut self) -> &mut W

Mutably dereferences the value.

impl<W: ConsoleWrite> Drop for AlternateScreen<W>

fn drop(&mut self)

Executes the destructor for this type.

impl<W: ConsoleWrite> Write for AlternateScreen<W>

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

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

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

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

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

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

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

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

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

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl<W: ConsoleWrite> Deref for AlternateScreen<W>

type Target = W

The resulting type after dereferencing.

fn deref(&self) -> &W

Dereferences the value.