Trait pomprt::Editor

source ·

pub trait Editor {
    // Provided methods
    fn next_event(&mut self, input: &mut Reader<impl Read>) -> Result<Event> { ... }
    fn insert(&self, buffer: &mut String, cursor: &mut usize, c: char) { ... }
    fn complete(&self, buffer: &str, cursor: usize) -> Option<Completion> { ... }
    fn indent(&self, buffer: &mut String, cursor: &mut usize) { ... }
    fn highlight(&self, buffer: &str) -> String { ... }
    fn highlight_prompt(&self, prompt: &str, multiline: bool) -> String { ... }
    fn hint(&self, buffer: &str) -> Option<String> { ... }
    fn highlight_hint(&self, hint: &str) -> String { ... }
    fn is_multiline(&self, buffer: &str, cursor: usize) -> bool { ... }
    fn is_keyword(c: char) -> bool { ... }
}

Expand description

Custom editor behaviour for a Prompt

All functions provided may be overrided with custom ones. For instance, colors may be added by implementing Editor::highlight. Detailed examples can be found in the examples directory.

Provided Methods§

source

fn next_event(&mut self, input: &mut Reader<impl Read>) -> Result<Event>

Reads ANSI sequences from input and returns an editor event

source

fn insert(&self, buffer: &mut String, cursor: &mut usize, c: char)

Inserts a character at the current cursor position, moving it forward

Note that cursor should always lie inside a char boundary. This can usually be achieved by adding char::len_utf8 to it, instead of adding just 1 to move it forward.

source

fn complete(&self, buffer: &str, cursor: usize) -> Option<Completion>

Provides completion if available

Returning Some will cause Event::Tab to cycle through all results in the Vec, replacing buffer[start..end] until another key is pressed. Otherwise, Editor::indent is called.

source