Struct raw_tty::TtyWithGuard

pub struct TtyWithGuard<T: AsRawFd> { /* fields omitted */ }

Wraps a file descriptor for a TTY with a guard which saves the terminal mode on creation and restores it on drop.

Methods

impl<T: AsRawFd> TtyWithGuard<T>

pub fn new(tty: T) -> Result<TtyWithGuard<T>>

pub fn modify_mode<F>(&mut self, f: F) -> Result<()> where
    F: FnOnce(Termios) -> Termios, 

Creates a copy of the saved termios and passes it to f which should return the new termios to apply.

This method can be used to restore the saved ios afterwards by using the identity function.

pub fn set_raw_mode(&mut self) -> Result<()>

Switch to raw mode.

Trait Implementations

impl<R: AsRawFd> Deref for TtyWithGuard<R>

type Target = R

The resulting type after dereferencing.

fn deref(&self) -> &R

Dereferences the value.

impl<R: AsRawFd> DerefMut for TtyWithGuard<R>

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

Mutably dereferences the value.

impl<R: Read + AsRawFd> Read for TtyWithGuard<R>

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.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl<R: Write + AsRawFd> Write for TtyWithGuard<R>

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

Write a buffer into this writer, returning how many bytes were written.

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

Flush 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 write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer 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

Creates a "by reference" adaptor for this instance of Write.