Struct console::Term

pub struct Term { /* fields omitted */ }

Abstraction around a terminal.

Methods

impl Term

fn stdout() -> Term

Return a new unbuffered terminal

fn stderr() -> Term

Return a new unbuffered terminal to stderr

fn buffered_stdout() -> Term

Return a new buffered terminal

fn buffered_stderr() -> Term

Return a new buffered terminal to stderr

fn write_line(&self, s: &str) -> Result<()>

Writes a string to the terminal and adds a newline.

fn read_char(&self) -> Result<char>

Read a single character from the terminal

This does not echo the character and blocks until a single character is entered.

fn read_key(&self) -> Result<Key>

Read a single key form the terminal.

This does not echo anything. If the terminal is not user attended the return value will always be the unknown key.

fn read_line(&self) -> Result<String>

Read one line of input.

This does not include the trailing newline. If the terminal is not user attended the return value will always be an empty string.

fn read_secure_line(&self) -> Result<String>

Read securely a line of input.

This is similar to read_line but will not echo the output. This also switches the terminal into a different mode where not all characters might be accepted.

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

Flushes internal buffers.

This forces the contents of the internal buffer to be written to the terminal. This is unnecessary for unbuffered terminals which will automatically flush.

fn is_term(&self) -> bool

Checks if the terminal is indeed a terminal.

Alternatively you can use the user_attended function which does the same.

fn want_emoji(&self) -> bool

Checks if this terminal wants emoji output.

fn size(&self) -> (u16, u16)

Returns the terminal size or gets sensible defaults.

fn size_checked(&self) -> Option<(u16, u16)>

Returns the terminal size in rows and columns.

If the size cannot be reliably determined None is returned.

fn move_cursor_up(&self, n: usize) -> Result<()>

Moves the cursor up n lines

fn move_cursor_down(&self, n: usize) -> Result<()>

Moves the cursor down n lines

fn clear_line(&self) -> Result<()>

Clears the current line.

The positions the cursor at the beginning of the line again.

fn clear_last_lines(&self, n: usize) -> Result<()>

Clear the last n lines.

This positions the cursor at the beginning of the first line that was cleared.

Trait Implementations

impl AsRawFd for Term

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Write for Term

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

Write a buffer into this object, 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_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this write.

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.

impl Read for Term

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.

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, placing them into 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 chars(self) -> Chars<Self>

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

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an [Iterator] over [char]s.

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.