3 releases

0.5.3 Jul 19, 2024
0.5.2 Nov 4, 2023
0.5.1 Nov 29, 2019

#32 in Text editors

Download history 84/week @ 2024-08-23 150/week @ 2024-08-30 147/week @ 2024-09-06 207/week @ 2024-09-13 234/week @ 2024-09-20 206/week @ 2024-09-27 137/week @ 2024-10-04 169/week @ 2024-10-11 263/week @ 2024-10-18 145/week @ 2024-10-25 180/week @ 2024-11-01 116/week @ 2024-11-08 191/week @ 2024-11-15 190/week @ 2024-11-22 207/week @ 2024-11-29 200/week @ 2024-12-06

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

MIT license

235KB
6K SLoC

liner

A Rust library offering readline-like functionality.

CONTRIBUTING.md

Build Status Docs

Features

  • 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.3"
...

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

~2MB
~37K SLoC