Struct Conout

pub struct Conout { /* private fields */ }

Represents the output side of the tty/console terminal.

This is a singleton that aquires a lock to access the console (similiar to Stdin). It should be used to access the tty/terminal to avoid conflicts and other issues.

Implementations

impl Conout

pub fn lock<'a>(&self) -> ConsoleOutLock<'a>

Locks the output console and returns a guard.

Lock is released when the guard is dropped.

pub fn try_lock<'a>(&self) -> Option<ConsoleOutLock<'a>>

Tries to lock the output console and returns Some(guard) if it could or None if it could not. If the lock is already held by another thread then it will return None. Underlying lock is a ReentrantMutex from parking lot so will be fine to use on the same thread.

Lock is released when the guard is dropped.

Trait Implementations

impl AsRawFd for Conout

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl ConsoleWrite for Conout

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 Write for Conout

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.