tree: bcfa9f28127c163e4e74924ee4de07fc3239aa09 [path history] [tgz]
  1. .gitignore
  2. .travis.yml
  3. Cargo.toml
  4. LICENSE
  5. README.md
  6. deploy-docs.sh
  7. examples/
  8. rustfmt.toml
  9. src/
README.md

RustyLine

Build Status

Readline implementation in Rust that is based on Antirez' Linenoise

Documentation

Build

This project uses Cargo and Rust Nightly

cargo build --release

Example

extern crate rustyline;

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

fn main() {
    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]
rustyline = "0.2.3"

Features

Actions

KeystrokeAction
Ctrl-A, HomeMove cursor to the beginning of line
Ctrl-B, LeftMove cursor one character left
Ctrl-CInterrupt/Cancel edition
Ctrl-D, Del(if line is not empty) Delete character under cursor
Ctrl-D(if line is empty) End of File
Ctrl-E, EndMove cursor to end of line
Ctrl-F, RightMove cursor one character right
Ctrl-H, BackSpaceDelete character before cursor
Ctrl-J, ReturnFinish the line entry
Ctrl-KDelete from cursor to end of line
Ctrl-LClear screen
Ctrl-N, DownNext match from history
Ctrl-P, UpPrevious match from history
Ctrl-RReverse Search history (Ctrl-S forward, Ctrl-G cancel)
Ctrl-TTranspose previous character with current character
Ctrl-UDelete from start of line to cursor
Ctrl-VInsert any special character without perfoming its associated action
Ctrl-WDelete word leading up to cursor (using white space as a word boundary)
Ctrl-YPaste from Yank buffer (Alt-Y to paste next yank instead)
TabNext completion
Alt-B, Alt-LeftMove cursor to previous word
Alt-CCapitalize the current word
Alt-DDelete forwards one word
Alt-F, Alt-RightMove cursor to next word
Alt-LLower-case the next word
Alt-TTranspose words
Alt-UUpper-case the next word
Alt-YSee Ctrl-Y
Alt-BackSpaceKill from the start of the current word, or, if between words, to the start of the previous word

ToDo

  • Show completion list
  • expose an API callable from C