pub struct Context {
pub history: History,
/* private fields */
}
Expand description
Primary interface to readline-like functionality
Fields§
§history: History
Implementations§
Source§impl Context
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
Sourcepub fn read_line(
&mut self,
prompt: Prompt,
f: Option<ColorClosure>,
) -> Result<String>
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.
Sourcepub fn edit_line<B: Into<Buffer>>(
&mut self,
prompt: Prompt,
f: Option<ColorClosure>,
buffer: B,
) -> Result<String>
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§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more