Struct arret::subcommand::repl::arret_helper::ArretHelper

pub struct ArretHelper {
    all_names: Vec<DataStr>,
}

Implementation of Rustyline’s Helper trait

Fields

all_names: Vec<DataStr>

Implementations

impl ArretHelper

pub fn new(bound_names: Vec<DataStr>) -> ArretHelper

Trait Implementations

impl Completer for ArretHelper

type Candidate = String

Specific completion candidate.

fn complete(
    &self,
    line: &str,
    pos: usize,
    _: &Context<'_>
) -> 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 word to be completed.

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

Updates the edited line with the elected candidate.

impl Highlighter for ArretHelper

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: '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_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.

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

impl Hinter for ArretHelper

type Hint = String

Specific hint type

fn hint(&self, line: &str, pos: usize, _: &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 ArretHelper

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.

impl Helper for ArretHelper