Struct MouseTerminal

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

A terminal with added mouse support.

This can be obtained through the From implementations. You can use this if you want an RAII guard around terminal mouse support.

Trait Implementations

impl<W: ConsoleWrite> ConsoleWrite for MouseTerminal<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 MouseTerminal<W>

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

Mutably dereferences the value.

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

fn drop(&mut self)

Executes the destructor for this type.

impl<W: ConsoleWrite> From<W> for MouseTerminal<W>

fn from(from: W) -> MouseTerminal<W>

Converts to this type from the input type.

impl<W: ConsoleWrite> Write for MouseTerminal<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 MouseTerminal<W>

type Target = W

The resulting type after dereferencing.

fn deref(&self) -> &W

Dereferences the value.