Enum CandidateKind 

#[non_exhaustive]
pub enum CandidateKind {
    Value,
    Command,
    Flag,
    File,
    Directory,
}

The semantic role of one completion candidate.

PowerShell presents these with its native result types. Other shells currently preserve the value and description while ignoring the kind.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Value

Command

Flag

File

Directory

Trait Implementations

impl Clone for CandidateKind

fn clone(&self) -> CandidateKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CandidateKind

impl Debug for CandidateKind

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

Formats the value using the given formatter.

impl Default for CandidateKind

fn default() -> CandidateKind

Returns the “default value” for a type.

impl Eq for CandidateKind

impl Ord for CandidateKind

fn cmp(&self, other: &CandidateKind) -> 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 PartialEq for CandidateKind

fn eq(&self, other: &CandidateKind) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CandidateKind

fn partial_cmp(&self, other: &CandidateKind) -> 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 StructuralPartialEq for CandidateKind