Struct Context

Source

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

Fields§

§history: History§completer: Option<Box<dyn Completer>>§word_divider_fn: Box<dyn Fn(&Buffer) -> Vec<(usize, usize)>>§key_bindings: KeyBindings

Implementations§

Source §

impl Context

Source

pub fn new() -> Self

Source

pub fn read_line<P: Into<String>>( &mut self, prompt: P, handler: &mut EventHandler<'_, RawTerminal<Stdout>>, ) -> 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.

Source

pub fn read_line_with_init_buffer<P: Into<String>, B: Into<Buffer>>( &mut self, prompt: P, handler: &mut EventHandler<'_, RawTerminal<Stdout>>, buffer: B, ) -> Result<String>

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

use liner::Context;
let mut context = Context::new();
let line =
    context.read_line_with_init_buffer("[prompt]$ ",
                                       &mut |_| {},
                                       "some initial buffer");

Source