Struct Terminal

pub struct Terminal<I: TermIn, O: TermOut> { /* private fields */ }

Terminal

Stores the current termios stuff and derives a new termios object. It also reverts changes on drop. All fields should be treated as private, mutating any of them (pointer magic included) will break the system.

If I implements BufRead, then Terminal will implement BufRead.

Implementations

impl<I: TermIn, O: TermOut> Terminal<I, O>

pub fn new(input: I, output: O) -> Result<Self>

constructs a new Terminal object and puts it in control. If you’re using stdin/stdout, it’s recommended to lock them first since it gives you StdinLock/StdoutLock, which gives you the BufRead trait.

Examples found in repository

examples/naive.rs (line 8)

fn main() -> io::Result<()> {
    let mut terminal = TJ::Terminal::new(stdin().lock(), stdout().lock())?;
    for i in 0 .. 16 {
        let ri = 15 - i;
        terminal.foreground(TJ::Colour::Term(i as u8))?;
        terminal.background(TJ::Colour::Term(ri as u8))?;
        terminal.write(format!("The colour of term col {i:>02}:{ri:>02}")
                               .as_bytes())?;
        terminal.style_clear()?;
        terminal.write(b"\n")?;
        terminal.flush()?;
    }
    Ok(())
}

pub fn change<'a>(&'a mut self) -> Transform<'a, I, O>

prep a transform object for changing the current termios object.

pub fn foreground(&mut self, col: Colour) -> Result<()>

foreground

sets the foreground colour

Examples found in repository

examples/naive.rs (line 11)

fn main() -> io::Result<()> {
    let mut terminal = TJ::Terminal::new(stdin().lock(), stdout().lock())?;
    for i in 0 .. 16 {
        let ri = 15 - i;
        terminal.foreground(TJ::Colour::Term(i as u8))?;
        terminal.background(TJ::Colour::Term(ri as u8))?;
        terminal.write(format!("The colour of term col {i:>02}:{ri:>02}")
                               .as_bytes())?;
        terminal.style_clear()?;
        terminal.write(b"\n")?;
        terminal.flush()?;
    }
    Ok(())
}

pub fn background(&mut self, col: Colour) -> Result<()>

background

sets the background colour

Examples found in repository

examples/naive.rs (line 12)

fn main() -> io::Result<()> {
    let mut terminal = TJ::Terminal::new(stdin().lock(), stdout().lock())?;
    for i in 0 .. 16 {
        let ri = 15 - i;
        terminal.foreground(TJ::Colour::Term(i as u8))?;
        terminal.background(TJ::Colour::Term(ri as u8))?;
        terminal.write(format!("The colour of term col {i:>02}:{ri:>02}")
                               .as_bytes())?;
        terminal.style_clear()?;
        terminal.write(b"\n")?;
        terminal.flush()?;
    }
    Ok(())
}

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

Examples found in repository

examples/naive.rs (line 15)

fn main() -> io::Result<()> {
    let mut terminal = TJ::Terminal::new(stdin().lock(), stdout().lock())?;
    for i in 0 .. 16 {
        let ri = 15 - i;
        terminal.foreground(TJ::Colour::Term(i as u8))?;
        terminal.background(TJ::Colour::Term(ri as u8))?;
        terminal.write(format!("The colour of term col {i:>02}:{ri:>02}")
                               .as_bytes())?;
        terminal.style_clear()?;
        terminal.write(b"\n")?;
        terminal.flush()?;
    }
    Ok(())
}

pub fn pull_utf8(&mut self) -> Result<Option<char>>

Trait Implementations

impl<I: TermIn + BufRead, O: TermOut> BufRead for Terminal<I, O>

fn consume(&mut self, amt: usize)

Marks the given amount of additional bytes from the internal buffer as having been read. Subsequent calls to read only return bytes that have not been marked as read.

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data, via Read methods, if empty.

fn has_data_left(&mut self) -> Result<bool, Error>

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

Checks if there is any data left to be read.

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

Reads all bytes into buf until the delimiter byte or EOF is reached.

fn skip_until(&mut self, byte: u8) -> Result<usize, Error>

Skips all bytes until the delimiter byte or EOF is reached.

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

Reads all bytes until a newline (the 0xA byte) is reached, and append them to the provided String buffer.

fn split(self, byte: u8) -> Split<Self>

where Self: Sized,

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

where Self: Sized,

Returns an iterator over the lines of this reader.

impl<I: TermIn, O: TermOut> Drop for Terminal<I, O>

fn drop(&mut self)

automatically revert termios object.

impl<I: TermIn, O: TermOut> Read for Terminal<I, O>

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.

impl<I: TermIn, O: TermOut> Write for Terminal<I, O>

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, args: 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.