Struct CommandHelper

pub struct CommandHelper { /* private fields */ }

Implementations

impl CommandHelper

pub fn new() -> Self

pub fn set_commands(&mut self, commands: Vec<String>)

pub fn set_completions(&mut self, completions: HashMap<String, Completion>)

Trait Implementations

impl Completer for CommandHelper

type Candidate = String

Specific completion candidate.

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

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, changes: &mut Changeset, )

Updates the edited line with the elected candidate.

impl Highlighter for CommandHelper

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_prompt<'b, 's, 'p>( &'s self, prompt: &'p str, default: bool, ) -> Cow<'b, str>

where 's: 'b, 'p: 'b,

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).

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.

impl Hinter for CommandHelper

type Hint = String

Specific hint type

fn hint(&self, line: &str, pos: usize, ctx: &Context<'_>) -> Option<Self::Hint>

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 CommandHelper

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

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 CommandHelper