Struct Context

pub struct Context {
    pub history: History,
    /* private fields */
}

Primary interface to readline-like functionality

Fields

history: History

Implementations

impl Context

pub fn new() -> Self

pub fn set_completer(&mut self, completer: Box<dyn Completer>) -> &mut Self

pub fn set_keymap(&mut self, keymap: Box<dyn KeyMap>) -> &mut Self

pub fn set_editor_rules(&mut self, rules: Box<dyn EditorRules>) -> &mut Self

pub fn read_line( &mut self, prompt: Prompt, f: Option<ColorClosure>, ) -> Result<String>

Creates an Editor and feeds it keypresses from stdin until the line is entered. The output is stdout. The returned line has the newline removed. Before returning, will revert all changes to the history buffers.

pub fn edit_line<B: Into<Buffer>>( &mut self, prompt: Prompt, f: Option<ColorClosure>, buffer: B, ) -> Result<String>

Same as Context.read_line(), but passes the provided initial buffer to the editor.

use sl_liner::{Context, Completer, Prompt};

struct EmptyCompleter;

impl Completer for EmptyCompleter {
    fn completions(&mut self, _start: &str) -> Vec<String> {
        Vec::new()
    }
}

let mut context = Context::new();
context.set_completer(Box::new(EmptyCompleter{}));
let line =
    context.edit_line(Prompt::from("[prompt]$ "),
                      Some(Box::new(|s| String::from(s))),
                      "some initial buffer");

Trait Implementations

impl Default for Context

fn default() -> Self

Returns the “default value” for a type.