RustyLine

Readline implementation in Rust that is based on Antirez' Linenoise

Documentation (Releases)

Documentation (Master)

Supported Platforms

• Linux
• Windows
  • cmd.exe
  • Powershell

Note: Powershell ISE is not supported, check issue #56

This fork

This fork is just to provide a respository for a repackaging of the rustyline crate.

Build

This project uses Cargo and Rust stable

cargo build --release

Example

extern crate wee_rl as rustyline;

use rustyline::error::ReadlineError;
use rustyline::Editor;

fn main() {
    // `()` can be used when no completer is required
    let mut rl = Editor::<()>::new();
    if let Err(_) = rl.load_history("history.txt") {
        println!("No previous history.");
    }
    loop {
        let readline = rl.readline(">> ");
        match readline {
            Ok(line) => {
                rl.add_history_entry(&line);
                println!("Line: {}", line);
            },
            Err(ReadlineError::Interrupted) => {
                println!("CTRL-C");
                break
            },
            Err(ReadlineError::Eof) => {
                println!("CTRL-D");
                break
            },
            Err(err) => {
                println!("Error: {:?}", err);
                break
            }
        }
    }
    rl.save_history("history.txt").unwrap();
}

crates.io

You can use this package in your project by adding the following to your Cargo.toml:

[dependencies]
wee-rl = "1.0.0"

Features

• Unicode (UTF-8) (linenoise supports only ASCII)
• Word completion (linenoise supports only line completion)
• Filename completion
• History search (Searching for Commands in the History)
• Kill ring (Killing Commands)
• Multi line mode
• Word commands

Actions

For all modes:

Emacs mode (default mode)

Readline Emacs Editing Mode Cheat Sheet

Vi command mode

$, End | Move cursor to end of line . | Redo the last text modification ; | Redo the last character finding command , | Redo the last character finding command in opposite direction 0, Home | Move cursor to the beginning of line ^ | Move to the first non-blank character of line a | Insert after cursor A | Insert at the end of line b | Move one word or token left B | Move one non-blank word left c | Change text of a movement command C | Change text to the end of line (equivalent to c$) d | Delete text of a movement command D, Ctrl-K | Delete to the end of the line e | Move to the end of the current word E | Move to the end of the current non-blank word f | Move right to the next occurance of char F | Move left to the previous occurance of char h, Ctrl-H, BackSpace | Move one character left l, Space | Move one character right Ctrl-L | Clear screen i | Insert before cursor I | Insert at the beginning of line +, j, Ctrl-N | Move forward one command in history -, k, Ctrl-P | Move backward one command in history p | Insert the yanked text at the cursor (paste) P | Insert the yanked text before the cursor r | Replaces a single character under the cursor (without leaving command mode) s | Delete a single character under the cursor and enter input mode S | Change current line (equivalent to 0c$) t | Move right to the next occurance of char, then one char backward T | Move left to the previous occurance of char, then one char forward w | Move one word or token right W | Move one non-blank word right x | Delete a single character under the cursor X | Delete a character before the cursor y | Yank a movement into buffer (copy)

Vi insert mode

Readline VI Editing Mode Cheat Sheet

Terminal codes (ANSI/VT100)

ToDo

• Undos
• Read input with timeout to properly handle single ESC key
• expose an API callable from C

Wine

$ cargo run --example example --target 'x86_64-pc-windows-gnu'
...
Error: Io(Error { repr: Os { code: 6, message: "Invalid handle." } })
$ wineconsole --backend=curses target/x86_64-pc-windows-gnu/debug/examples/example.exe
...

Terminal checks

$ # current settings of all terminal attributes:
$ stty -a
$ # key bindings:
$ bind -p

Similar projects

• copperline (Rust)
• linefeed (Rust)
• liner (Rust)
• linenoise-ng (C++)
• liner (Go)
• readline (Go)
• haskeline (Haskell)