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.

Implementations

impl<W: Write> AlternateScreen<W>

pub fn from(mut 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> Deref for AlternateScreen<W>

type Target = W

The resulting type after dereferencing.

fn deref(&self) -> &W

Dereferences the value.

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

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

Mutably dereferences the value.

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

fn drop(&mut self)

Executes the destructor for this type.

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

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

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

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

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

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

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

pub 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.

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

Attempts to write an entire buffer into this writer.

pub 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.

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

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

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

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