Struct CompletionCandidate

pub struct CompletionCandidate { /* private fields */ }

Available on crate feature unstable-dynamic only.

A shell-agnostic completion candidate

Implementations

impl CompletionCandidate

pub fn new(value: impl Into<OsString>) -> Self

Create a new completion candidate

pub fn help(self, help: Option<StyledStr>) -> Self

Set the help message of the completion candidate

pub fn id(self, id: Option<String>) -> Self

Only first for a given Id is shown

To reduce the risk of conflicts, this should likely contain a namespace.

pub fn tag(self, tag: Option<StyledStr>) -> Self

Group candidates by tag

Future: these may become user-visible

pub fn display_order(self, order: Option<usize>) -> Self

Sort weight within a CompletionCandidate::tag

pub fn hide(self, hidden: bool) -> Self

Set the visibility of the completion candidate

Only shown when there is no visible candidate for completing the current argument.

pub fn add_prefix(self, prefix: impl Into<OsString>) -> Self

Add a prefix to the value of completion candidate

This is generally used for post-process by complete for things like pre-pending flags, merging delimiter-separated values, etc.

impl CompletionCandidate

Reflection API

pub fn get_value(&self) -> &OsStr

Get the literal value being proposed for completion

pub fn get_help(&self) -> Option<&StyledStr>

Get the help message of the completion candidate

pub fn get_id(&self) -> Option<&String>

Get the id used for de-duplicating

pub fn get_tag(&self) -> Option<&StyledStr>

Get the grouping tag

pub fn get_display_order(&self) -> Option<usize>

Get the grouping tag

pub fn is_hide_set(&self) -> bool

Get the visibility of the completion candidate

Trait Implementations

impl Debug for CompletionCandidate

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

Formats the value using the given formatter.

impl Default for CompletionCandidate

fn default() -> CompletionCandidate

Returns the “default value” for a type.

impl<S: Into<OsString>> From<S> for CompletionCandidate

fn from(s: S) -> Self

Converts to this type from the input type.

impl Ord for CompletionCandidate

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CompletionCandidate

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

impl StructuralPartialEq for CompletionCandidate