2 releases

0.5.2 Nov 4, 2023
0.5.1 Nov 29, 2019

#85 in Text editors

Download history 319/week @ 2024-01-11 185/week @ 2024-01-18 207/week @ 2024-01-25 168/week @ 2024-02-01 314/week @ 2024-02-08 220/week @ 2024-02-15 256/week @ 2024-02-22 222/week @ 2024-02-29 253/week @ 2024-03-07 238/week @ 2024-03-14 256/week @ 2024-03-21 321/week @ 2024-03-28 205/week @ 2024-04-04 234/week @ 2024-04-11 179/week @ 2024-04-18 195/week @ 2024-04-25

871 downloads per month
Used in 4 crates (3 directly)

MIT license

240KB
6K SLoC

liner

A Rust library offering readline-like functionality.

CONTRIBUTING.md

Build Status Docs

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.2"
...

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.

Dependencies

~1MB
~19K SLoC