Trait Completer 

pub trait Completer {
    type Candidate: Candidate;

    // Provided methods
    fn complete(
        &self,
        line: &str,
        pos: usize,
        ctx: &Context<'_>,
    ) -> Result<(usize, Vec<Self::Candidate>)> { ... }
    fn update(
        &self,
        line: &mut LineBuffer,
        start: usize,
        elected: &str,
        cl: &mut Changeset,
    ) { ... }
}

To be called for tab-completion.

Required Associated Types

type Candidate: Candidate

Specific completion candidate.

Provided Methods

fn complete( &self, line: &str, pos: usize, ctx: &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.

("ls /usr/loc", 11) => Ok((3, vec!["/usr/local/"]))

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

Updates the edited line with the elected candidate.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl Completer for ()

type Candidate = String

fn update( &self, _line: &mut LineBuffer, _start: usize, _elected: &str, _cl: &mut Changeset, )

impl<C: ?Sized + Completer> Completer for Arc<C>

type Candidate = <C as Completer>::Candidate

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

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

impl<C: ?Sized + Completer> Completer for Box<C>

type Candidate = <C as Completer>::Candidate

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

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

impl<C: ?Sized + Completer> Completer for Rc<C>

type Candidate = <C as Completer>::Candidate

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

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

Implementors

impl Completer for FilenameCompleter

type Candidate = Pair