Struct Candidate 

pub struct Candidate<'a> {
    pub value: String,
    pub kind: CandidateKind,
    pub display: Option<Cow<'a, str>>,
    pub description: Option<Cow<'a, str>>,
}

Something a shell could offer at the cursor.

value is what the shell inserts. display may replace it in shells whose completion API separates presentation from insertion, and description is the help shown beside it.

Fields

value: String

kind: CandidateKind

display: Option<Cow<'a, str>>

A presentation-only label. Zsh and PowerShell support this distinction; other shells display Self::value because their native candidate format couples the two.

description: Option<Cow<'a, str>>

Borrowed from the spec where it is already there, owned where a callback made it.

Implementations

impl Candidate<'_>

pub fn new(value: impl Into<String>) -> Candidate<'_>

A candidate with nothing to say about itself.

pub fn described( value: impl Into<String>, description: impl Into<String>, ) -> Candidate<'_>

A candidate and the line a shell shows beside it.

pub fn displayed(self, display: impl Into<String>) -> Candidate<'_>

Use a different label in shells that can display one value while inserting another.

pub fn with_kind(self, kind: CandidateKind) -> Candidate<'_>

Classify the candidate for shells that present semantic result types.

Trait Implementations

impl<'a> Clone for Candidate<'a>

fn clone(&self) -> Candidate<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Candidate<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> Eq for Candidate<'a>

impl<'a> Ord for Candidate<'a>

fn cmp(&self, other: &Candidate<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for Candidate<'a>

fn eq(&self, other: &Candidate<'a>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> PartialOrd for Candidate<'a>

fn partial_cmp(&self, other: &Candidate<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> StructuralPartialEq for Candidate<'a>