Trait Completer

pub trait Completer {
    type Candidate: Candidate;

    // Required method
    fn complete(
        &self,
        line: &str,
        pos: usize,
    ) -> Result<(usize, Vec<Self::Candidate>)>;

    // Provided method
    fn update(&self, line: &mut LineBuffer, start: usize, elected: &str) { ... }
}

To be called for tab-completion.

Required Associated Types

type Candidate: Candidate

Required Methods

fn complete( &self, line: &str, pos: usize, ) -> 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/”]))

Provided Methods

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

Updates the edited line with the elected candidate.

Implementations on Foreign Types

impl Completer for ()

type Candidate = String

fn complete(&self, _line: &str, _pos: usize) -> Result<(usize, Vec<String>)>

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

impl<'c, C: ?Sized + Completer> Completer for &'c C

type Candidate = <C as Completer>::Candidate

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

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

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

type Candidate = <C as Completer>::Candidate

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

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

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

type Candidate = <C as Completer>::Candidate

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

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

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

type Candidate = <C as Completer>::Candidate

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

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

Implementors

impl Completer for FilenameCompleter

type Candidate = Pair