Crate artichoke_readline

Helpers for integrating REPLs with GNU Readline.

This crate can be used to parse Readline editing mode from the standard set of GNU Readline config files.

Examples

use artichoke_readline::{get_readline_edit_mode, rl_read_init_file, EditMode};

if let Some(config) = rl_read_init_file() {
    if matches!(get_readline_edit_mode(config), Some(EditMode::Vi)) {
        println!("You have chosen wisely");
    }
}

Crate Features

The rustyline feature (enabled by default) adds trait implementations to allow EditMode to interoperate with the corresponding enum in the rustyline crate.

Enums

EditMode

Readline editing mode.

Functions

get_readline_edit_mode

Parse readline editing mode from the given byte content, which should be the contents of an inputrc config file.

rl_read_init_file

Read inputrc contents according to the GNU Readline hierarchy of config files.