3 releases

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

#28 in Text editors

Download history 138/week @ 2024-08-26 135/week @ 2024-09-02 145/week @ 2024-09-09 229/week @ 2024-09-16 227/week @ 2024-09-23 182/week @ 2024-09-30 132/week @ 2024-10-07 223/week @ 2024-10-14 222/week @ 2024-10-21 171/week @ 2024-10-28 141/week @ 2024-11-04 131/week @ 2024-11-11 210/week @ 2024-11-18 173/week @ 2024-11-25 196/week @ 2024-12-02 257/week @ 2024-12-09

867 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