Struct NeumannHelper 

pub struct NeumannHelper { /* private fields */ }

Combined helper providing completion, highlighting, hints, and validation.

Implementations

impl NeumannHelper

pub fn new(theme: Theme) -> Self

Creates a new helper with the given theme.

pub fn set_tables(&mut self, tables: Vec<String>)

Updates the list of available tables for completion.

Trait Implementations

impl Completer for NeumannHelper

type Candidate = Pair

Specific completion candidate.

fn complete( &self, line: &str, pos: usize, ctx: &Context<'_>, ) -> Result<(usize, Vec<Pair>)>

Takes the currently edited line with the cursor position and returns the start position and the completion candidates for the partial word to be completed.

fn update( &self, line: &mut LineBuffer, start: usize, elected: &str, cl: &mut Changeset, )

Updates the edited line with the elected candidate.

impl Default for NeumannHelper

fn default() -> Self

Returns the “default value” for a type.

impl Highlighter for NeumannHelper

fn highlight<'l>(&self, line: &'l str, pos: usize) -> Cow<'l, str>

Takes the currently edited line with the cursor position and returns the highlighted version (with ANSI color).

fn highlight_char(&self, line: &str, pos: usize, kind: CmdKind) -> bool

Tells if line needs to be highlighted when a specific char is typed or when cursor is moved under a specific char.

fn highlight_prompt<'b, 's: 'b, 'p: 'b>( &'s self, prompt: &'p str, default: bool, ) -> Cow<'b, str>

Takes the prompt and returns the highlighted version (with ANSI color).

fn highlight_hint<'h>(&self, hint: &'h str) -> Cow<'h, str>

Takes the hint and returns the highlighted version (with ANSI color).

fn highlight_candidate<'c>( &self, candidate: &'c str, completion: CompletionType, ) -> Cow<'c, str>

Takes the completion candidate and returns the highlighted version (with ANSI color).

impl Hinter for NeumannHelper

type Hint = String

Specific hint type

fn hint(&self, _line: &str, _pos: usize, _ctx: &Context<'_>) -> Option<String>

Takes the currently edited line with the cursor position and returns the string that should be displayed or None if no hint is available for the text the user currently typed.

impl Validator for NeumannHelper

fn validate(&self, ctx: &mut ValidationContext<'_>) -> Result<ValidationResult>

Takes the currently edited input and returns a ValidationResult indicating whether it is valid or not along with an option message to display about the result. The most common validity check to implement is probably whether the input is complete or not, for instance ensuring that all delimiters are fully balanced.

fn validate_while_typing(&self) -> bool

Configure whether validation is performed while typing or only when user presses the Enter key.

impl Helper for NeumannHelper