Crate rucline

Rucline, the Rust CLI Line reader, or simply “recline”, is a cross-platform, UTF-8 compatible line reader that provides hooks for autocompletion and tab suggestion. It supports advanced editing actions and hooks for customizing the line reader behavior making it more flexible than simply reading from stdin.

Basic usage:

use rucline::Outcome::Accepted;
use rucline::prompt::{Builder, Prompt};

if let Ok(Accepted(string)) = Prompt::from("What's you favorite website? ")
    // Add some tab completions (Optional)
    .suggester(vec![
        "https://www.rust-lang.org/",
        "https://docs.rs/",
        "https://crates.io/",
    ])
    //Block until value is ready
    .read_line()
{
    println!("'{}' seems to be your favorite website", string);
}

Actions

Rucline’s behavior can be customized and composed with use of actions.

There is a built-in set of default actions that will be executed upon user interaction. These are meant to feel natural when coming from the default terminal, while also adding further functionality and editing commands. For example, a few of the built-ins:

• Tab: cycle through completions
• Shift + Tab: cycle through completions in reverse
• CTRL + W: delete the current word
• CTRL + J: delete until the beginning of the word
• CTRL + K: delete until the end of the word
• CTRL + U: delete the whole line
• CTRL + H: delete until the beggining of the line
• CTRL + L: delete until the end of the line

See Action for the full default behavior specification

The default behavior can be customized by overriding user events with actions. Which in turn can be serialized, stored, and loaded at run-time.

Overriding key bindings

use rucline::Outcome::Accepted;
use rucline::actions::{Action, Event, KeyBindings, KeyCode, Range};
use rucline::prompt::{Builder, Prompt};

let mut bindings = KeyBindings::new();

// Accept the full suggestions if `right` is pressed
bindings.insert(Event::from(KeyCode::Right), Action::Complete(Range::Line));

if let Ok(Accepted(string)) = Prompt::from("What's you favorite website? ")
    // Add some likely values as completions
    .completer(vec![
        "https://www.rust-lang.org/",
        "https://docs.rs/",
        "https://crates.io/",
    ])
    // Set the new key bindings as an override
    .overrider(bindings)
    //Block until value is ready
    .read_line()
{
    println!("'{}' seems to be your favorite website", string);
}

Re-exports

• pub use prompt::Outcome;
• pub use crossterm;

Modules

• actions
  Provides mappings and actions to change the behavior of the prompt when reading user input.
• completion
  Provides completion methods for prompt when reading lines.
• prompt
  Provides a method for presenting a prompt for user input that can be customized with actions and completions.

Structs

• Buffer
  A String that also keeps track of its cursor position.

Enums

• Error
  Alias to crossterm::ErrorKind from crossterm. Wrapper for all errors that can occur in crossterm.