Trait Terminal 

pub trait Terminal {
    // Required methods
    fn write(&mut self, bytes: &[u8]) -> Result<()>;
    fn read(
        &mut self,
        buf: &mut [u8],
        timeout: Option<Duration>,
    ) -> Result<Option<usize>>;

    // Provided methods
    fn restore(&mut self) -> Result<()> { ... }
    fn modes(&mut self, _paste: bool, _kitty: bool) { ... }
    fn waker(&self) -> Option<Waker> { ... }
}

A byte stream to a terminal with a timed read.

Required Methods

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

Writes all of bytes and flushes.

Errors

When the output fails.

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

Reads available input into buf, waiting at most timeout (None waits for input). Ok(None) means the wait timed out; Ok(Some(0)) that the input is closed.

Errors

When the input fails.

Provided Methods

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

Puts the terminal back as it was (leaves raw mode). Called once, when the session closes or fails to connect.

Errors

When the terminal can’t be restored.

fn modes(&mut self, _paste: bool, _kitty: bool)

Notes which input modes the session enabled, so a process killed by a signal can still undo them.

fn waker(&self) -> Option<Waker>

The waker that interrupts read, when the terminal has one. A session reports a wake as Ok(None) from its wait.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl Terminal for Tty

Available on Unix or Windows only.