sl_liner

Struct Context

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

Primary interface to readline-like functionality

Fields§

§history: History

Implementations§

Source§

impl Context

Source

pub fn new() -> Self

Source

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

Source

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

Source

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

Source

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.

Source

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§

Source§

impl Default for Context

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Context

§

impl !RefUnwindSafe for Context

§

impl !Send for Context

§

impl !Sync for Context

§

impl Unpin for Context

§

impl !UnwindSafe for Context

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.