Struct Tty 

pub struct Tty { /* private fields */ }

The process’s own terminal (stdin and stdout), in raw mode while it lives.

Implementations

impl Tty

pub fn open() -> Result<Self>

Switches the terminal to raw input: no echo, no line editing, no signals from keys (Ctrl+C is a key). Output processing stays on.

Errors

When stdin is not a terminal or its mode can’t be changed.

Trait Implementations

impl Debug for Tty

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Tty

Available on Unix or Windows only.

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Terminal for Tty

Available on Unix or Windows only.

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

Writes all of bytes and flushes.

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.

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.

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.