reedline 0.48.0

A readline-like crate for CLI text input
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

mod example;
mod simple_match;

use crate::StyledText;

pub use example::ExampleHighlighter;
pub use simple_match::SimpleMatchHighlighter;
/// The syntax highlighting trait. Implementers of this trait will take in the current string and then
/// return a `StyledText` object, which represents the contents of the original line as styled strings
pub trait Highlighter: Send {
    /// The action that will handle the current buffer as a line and return the corresponding `StyledText` for the buffer
    ///
    /// Cursor position as byte offsets in the string
    fn highlight(&self, line: &str, cursor: usize) -> StyledText;

    /// The action that will take the current buffer and return whether the cursor position (a byte
    /// offset) is inside a string literal
    fn is_inside_string_literal(&self, line: &str, cursor: usize) -> bool {
        let _ = (line, cursor);
        false // default for simple highlighters
    }
}