Struct xcli::PrefixCompleter

pub struct PrefixCompleter { /* fields omitted */ }

A PrefixCompleter for subcommands

Implementations

impl PrefixCompleter

pub fn new(cmd_tree: &Command<'_>) -> Self

Constructor, take the command tree as input

pub fn complete_cmd(
    &self,
    line: &str,
    pos: usize
) -> Result<(usize, Vec<String>)>

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

pub fn _complete_cmd(node: &PrefixNode, line: &str, pos: usize) -> Vec<String>

Get all commands that match the line and pos

Trait Implementations

impl Completer for PrefixCompleter

type Candidate = String

Specific completion candidate.

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

Complete command

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

Updates the edited line with the elected candidate.

impl Helper for PrefixCompleter

impl Highlighter for PrefixCompleter

pub fn highlight(&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).

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

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

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

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

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

pub fn highlight_char(&self, line: &str, pos: usize) -> 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 PrefixCompleter

pub 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 PrefixCompleter

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

pub fn validate_while_typing(&self) -> bool

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