Struct liner::Context

pub struct Context {
    pub history: History,
    pub word_divider_fn: Box<dyn Fn(&Buffer) -> Vec<(usize, usize)>>,
    pub key_bindings: KeyBindings,
    pub buf: String,
}

Fields

history: History

word_divider_fn: Box<dyn Fn(&Buffer) -> Vec<(usize, usize)>>

key_bindings: KeyBindings

buf: String

Methods

impl Context

pub fn new() -> Self

pub fn read_line<P: Into<String>, C: Completer>(
    &mut self,
    prompt: P,
    f: Option<ColorClosure>,
    handler: &mut C
) -> 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 read_line_with_init_buffer<P: Into<String>, B: Into<Buffer>, C: Completer>(
    &mut self,
    prompt: P,
    handler: &mut C,
    f: Option<ColorClosure>,
    buffer: B
) -> Result<String>

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

use liner::{Context, Completer};

struct EmptyCompleter;

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

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

pub fn revert_all_history(&mut self)

Trait Implementations

impl Default for Context

fn default() -> Self

Returns the "default value" for a type.