Struct Conin

pub struct Conin { /* private fields */ }

Represents the input 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 Conin

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

Locks the input console and returns a guard.

Lock is released when the guard is dropped.

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

Tries to lock the input 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 Conin

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl ConsoleRead for Conin

fn get_event_and_raw( &mut self, timeout: Option<Duration>, ) -> Option<Result<(Event, Vec<u8>)>>

Get the next input event from the console and the bytes that define it. If timeout is not None then will return a WouldBlock error after timeout if no input. Returns None if the Console has no more data vs a read that would block.

fn poll(&mut self, timeout: Option<Duration>) -> bool

Return when more data is avialable or timeout is reached. If timeout is None will poll until data is available. Returns true if more data was ready, false if timed out.

fn read_timeout( &mut self, buf: &mut [u8], timeout: Option<Duration>, ) -> Result<usize>

Read data (like read) but with an optional timeout. If timeout is None then block until there is something to read. If timeout is a value then return after the timeout if nothing is available to read. Returns a Err of kind WouldBlock if it times out.

impl Read for Conin

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

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

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.