Struct nixterm::term::Term

pub struct Term<I, O> where
    I: Read + AsRawFd,
    O: Write + AsRawFd,  {
    pub info: TermInfoBuf,
    // some fields omitted
}

Fields

info: TermInfoBuf

Methods

impl Term<Stdin, Stdout>

pub fn new() -> Result<Term<Stdin, Stdout>>

impl<I, O> Term<I, O> where
    I: Read + AsRawFd,
    O: Write + AsRawFd, 

Term represents the user's terminal. It has two channels, I (input), and O (output). Each terminal is accompanied by a "terminfo" file, (represented by the TermInfoBuf struct).

pub fn from_streams(tib: TermInfoBuf, stdin: I, stdout: O) -> Term<I, O>

Important traits for TermWriter<'a, O>

impl<'a, O> Write for TermWriter<'a, O> where
    O: Write + AsRawFd, 

pub fn writer<'a>(&'a self) -> TermWriter<'a, O>

Write to the terminal's stdout, it returns the number of bytes written. write does not need a mutable reference to self, meaning it can be used while self is being borrowed, however write blocks if it's being called from another thread.

Examples

use nixterm::term::Term;

pub fn main() {
    let term = Term::new().unwrap();
    term.writer()
        .foreground("rgb(64, 64, 128)")
        .write(b" Look look look! I'm kinda blue now!\n")
        .flush()
        .err()
        .unwrap();
}

pub fn print<T: AsRef<str>>(&self, s: T) -> Result<usize>

pub fn println<T: AsRef<str>>(&self, s: T) -> Result<usize>

pub fn read(&self, buffer: &mut [u8]) -> usize

Read from the terminal's standard input. Read into a fixed length buffer and return the number of characters read. Similar to Term::write, read does not need Term to be mutable, however only one thread may be reading at a time.

Examples

use nixterm::term::Term;

pub fn main() {
    let term = Term::new().unwrap();
    let mut buffer : [u8; 12] = [0; 12];
     
    // There's nothing to read! so read does nothing and returns 0.
    assert_eq!(term.read(&mut buffer), 0);
    assert_eq!(buffer, [0; 12]);
}

pub fn readline(&self) -> Result<String>

pub fn err(&self) -> Result<()>

pub fn settings(&self) -> Settings

pub fn update(&self, settings: Settings) -> Result<()>

pub fn flush(&self)

Important traits for Keys<'a, I, O>

impl<'a, I, O> Iterator for Keys<'a, I, O> where
    I: Read + AsRawFd + 'a,
    O: Write + AsRawFd + 'a,  type Item = Result<Key>;

pub fn read_keys<'a>(&'a self) -> Keys<'a, I, O>

pub fn clear_line_after_cursor(&self)

pub fn save_cursor(&self)

pub fn restore_cursor(&self)

pub fn prompt<T: AsRef<str>>(&self, prompt: T) -> Result<String>

pub fn colors(&self) -> usize

Trait Implementations

impl<I, O> AsRawFd for Term<I, O> where
    I: Read + AsRawFd,
    O: Write + AsRawFd, 

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.