isabella232 / liner-1

Mirror of https://gitlab.redox-os.org/redox-os/liner

liner

A Rust library offering readline-like functionality.

CONTRIBUTING.md

Featues

• Autosuggestions
• Emacs and Vi keybindings
• Multi-line editing
• History
• (Incomplete) basic and filename completions
• Reverse search
• Remappable keybindings

Basic Usage

In Cargo.toml:

[dependencies]
redox_liner = "0.5.1"
...

In src/main.rs:

extern crate liner;

use liner::{Context, Completer};

struct EmptyCompleter;

impl<W: std::io::Write> Completer<W> for EmptyCompleter {
    fn completions(&mut self, _start: &str) -> Vec<String> {
        Vec::new()
    }
}

fn main() {
    let mut con = Context::new();

    loop {
        let res = con.read_line("[prompt]$ ", &mut EmptyCompleter).unwrap();

        if res.is_empty() {
            break;
        }

        con.history.push(res.into());
    }
}

See src/main.rs for a more sophisticated example.

License

MIT licensed. See the LICENSE file.