rustpython::shell::rustyline_helper::ShellHelper - Rust

type Candidate = String

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

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. Read more

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

Updates the edited line with the elected candidate.

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

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

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

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

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

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

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. Read more

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. Read more

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. Read more

fn validate_while_typing(&self) -> bool

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

fn from(t: T) -> T[src]

Performs the conversion.

fn into(self) -> U[src]

Performs the conversion.

type Output = T

Should always be Self