Crate rustyline

Readline for Rust

This implementation is based on Antirez’s Linenoise

Example

Usage

let mut rl = rustyline::Editor::<()>::new();
let readline = rl.readline(">> ");
match readline {
    Ok(line) => println!("Line: {:?}", line),
    Err(_) => println!("No input"),
}

Re-exports

• pub use config::ColorMode;
• pub use config::CompletionType;
• pub use config::Config;
• pub use config::EditMode;
• pub use config::HistoryDuplicates;

Modules

• completion
  Completion API
• config
  Customize line editor
• error
  Contains error type for handling I/O and Errno errors
• highlight
  Syntax highlighting
• hint
  Hints (suggestions at the right of the prompt as you type).
• history
  History API
• line_buffer
  Line buffer with current cursor position

Structs

• Editor
  Line editor
• Iter
  Edited lines iterator

Enums

• Anchor
  Where to paste (relative to cursor position)
• At
  Where to move with respect to word boundary
• CharSearch
  Vi character search
• Cmd
  Commands #[non_exhaustive]
• KeyPress
  #[non_exhaustive]
• Movement
  Where to move
• Word
  Different word definitions

Traits

• Helper
  Syntax specific helper.

Type Aliases

• RepeatCount
  The number of times one command should be repeated.
• Result
  The error type for I/O and Linux Syscalls (Errno)