Struct rustyline::Editor

pub struct Editor<H: Helper> { /* fields omitted */ }

Line editor

Implementations

impl<H: Helper> Editor<H>

pub fn new() -> Self

Create an editor with the default configuration

pub fn with_config(config: Config) -> Self

Create an editor with a specific configuration.

pub fn readline(&mut self, prompt: &str) -> Result<String>

This method will read a line from STDIN and will display a prompt.

It uses terminal-style interaction if stdin is connected to a terminal. Otherwise (e.g., if stdin is a pipe or the terminal is not supported), it uses file-style interaction.

pub fn readline_with_initial(
    &mut self,
    prompt: &str,
    initial: (&str, &str)
) -> Result<String>

This function behaves in the exact same manner as readline, except that it pre-populates the input area.

The text that resides in the input area is given as a 2-tuple. The string on the left of the tuple is what will appear to the left of the cursor and the string on the right is what will appear to the right of the cursor.

pub fn load_history<P: AsRef<Path> + ?Sized>(&mut self, path: &P) -> Result<()>

Load the history from the specified file.

pub fn save_history<P: AsRef<Path> + ?Sized>(&mut self, path: &P) -> Result<()>

Save the history in the specified file.

pub fn append_history<P: AsRef<Path> + ?Sized>(
    &mut self,
    path: &P
) -> Result<()>

Append new entries in the specified file.

pub fn add_history_entry<S: AsRef<str> + Into<String>>(
    &mut self,
    line: S
) -> bool

Add a new entry in the history.

pub fn clear_history(&mut self)

Clear history.

pub fn history_mut(&mut self) -> &mut History

Return a mutable reference to the history object.

pub fn history(&self) -> &History

Return an immutable reference to the history object.

pub fn set_helper(&mut self, helper: Option<H>)

Register a callback function to be called for tab-completion or to show hints to the user at the right of the prompt.

pub fn helper_mut(&mut self) -> Option<&mut H>

Return a mutable reference to the helper.

pub fn helper(&self) -> Option<&H>

Return an immutable reference to the helper.

pub fn bind_sequence<E: Into<Event>, R: Into<EventHandler>>(
    &mut self,
    key_seq: E,
    handler: R
) -> Option<EventHandler>

Bind a sequence to a command.

pub fn unbind_sequence<E: Into<Event>>(
    &mut self,
    key_seq: E
) -> Option<EventHandler>

Remove a binding for the given sequence.

pub fn iter<'a>(
    &'a mut self,
    prompt: &'a str
) -> impl Iterator<Item = Result<String>> + 'a

Returns an iterator over edited lines

let mut rl = rustyline::Editor::<()>::new();
for readline in rl.iter("> ") {
    match readline {
        Ok(line) => {
            println!("Line: {}", line);
        }
        Err(err) => {
            println!("Error: {:?}", err);
            break;
        }
    }
}

pub fn dimensions(&mut self) -> Option<(usize, usize)>

If output stream is a tty, this function returns its width and height as a number of characters.

Trait Implementations

impl<H: Helper> Configurer for Editor<H>

fn config_mut(&mut self) -> &mut Config

Config accessor.

fn set_max_history_size(&mut self, max_size: usize)

Set the maximum length for the history.

fn set_history_ignore_dups(&mut self, yes: bool)

Tell if lines which match the previous history entry are saved or not in the history list.

fn set_history_ignore_space(&mut self, yes: bool)

Tell if lines which begin with a space character are saved or not in the history list.

fn set_color_mode(&mut self, color_mode: ColorMode)

Forces colorization on or off.

fn set_completion_type(&mut self, completion_type: CompletionType)

Set completion_type.

fn set_completion_prompt_limit(&mut self, completion_prompt_limit: usize)

The number of possible completions that determines when the user is asked whether the list of possibilities should be displayed.

fn set_keyseq_timeout(&mut self, keyseq_timeout_ms: i32)

Timeout for ambiguous key sequences in milliseconds.

fn set_edit_mode(&mut self, edit_mode: EditMode)

Choose between Emacs or Vi mode.

fn set_auto_add_history(&mut self, yes: bool)

Tell if lines are automatically added to the history.

fn set_bell_style(&mut self, bell_style: BellStyle)

Set bell style: beep, flash or nothing.

fn set_output_stream(&mut self, stream: OutputStreamType)

Whether to use stdout or stderr

fn set_tab_stop(&mut self, tab_stop: usize)

Horizontal space taken by a tab.

fn set_check_cursor_position(&mut self, yes: bool)

Check if cursor position is at leftmost before displaying prompt.

fn set_indent_size(&mut self, size: usize)

Indentation size for indent/dedent commands

fn enable_bracketed_paste(&mut self, enabled: bool)

Enable or disable bracketed paste on unix platform

impl<H: Helper> Debug for Editor<H>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.