Struct termion::screen::AlternateScreen

pub struct AlternateScreen<W: Write> { /* fields omitted */ }

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.

Methods

impl<W: Write> AlternateScreen<W>

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: Write> Drop for AlternateScreen<W>

fn drop(&mut self)

A method called when the value goes out of scope.

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

type Target = W

The resulting type after dereferencing

fn deref(&self) -> &W

The method called to dereference a value

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

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

The method called to mutably dereference a value

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

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

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

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

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

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

Attempts to write an entire buffer into this write.

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

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