Struct CompletionItem 

pub struct CompletionItem {
    pub value: String,
    pub completion_type: String,
    pub help: Option<String>,
}

A shell completion item.

Fields

value: String

The completion value.

completion_type: String

The type of completion (e.g., “file”, “dir”, “plain”).

help: Option<String>

Optional help text for the completion.

Implementations

impl CompletionItem

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

Create a new completion item with the given value.

pub fn with_type( value: impl Into<String>, completion_type: impl Into<String>, ) -> Self

Create a new completion item with a specific type.

pub fn with_help(self, help: impl Into<String>) -> Self

Add help text to this completion item.

Trait Implementations

impl Clone for CompletionItem

fn clone(&self) -> CompletionItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionItem

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

Formats the value using the given formatter.

impl Eq for CompletionItem

impl PartialEq for CompletionItem

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