Crate rustyline[−][src]

Expand description

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 crate::config::ColorMode;

pub use crate::config::CompletionType;

pub use crate::config::Config;

pub use crate::config::EditMode;

pub use crate::config::HistoryDuplicates;

pub use crate::config::OutputStreamType;

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

validate

Input validation API (Multi-line editing)

Structs

Context

Completion/suggestion context

Editor

Line editor

EventContext

Give access to user input.

KeyEvent

Input key pressed and modifiers

Modifiers

The set of modifier keys that were triggered along with a key press.

Enums

Anchor

Where to paste (relative to cursor position)

At

Where to move with respect to word boundary

character search

Commands

Input event

Event handler

Vi input modes

Input key pressed

Where to move

Different word definitions

Traits

ConditionalEventHandler

May behave differently depending on:

Helper

Syntax specific helper.

Type Definitions

RepeatCount

The number of times one command should be repeated.

Result

The error type for I/O and Linux Syscalls (Errno)