Struct DynamicSuggestion 

pub struct DynamicSuggestion {
    pub value: String,
    pub description: Option<String>,
    pub extra: Option<Vec<String>>,
    pub append_whitespace: bool,
    pub match_indices: Option<Vec<usize>>,
    pub span: Option<Span>,
    pub kind: Option<SuggestionKind>,
}

A simple semantics suggestion just like nu_cli::SemanticSuggestion, but it derives Serialize and Deserialize, so plugins are allowed to use it to provide dynamic completion items.

Why define a new one rather than put nu_cli::SemanticSuggestion here?

If bringing nu_cli::SemanticSuggestion here, it brings reedline::Suggestion too, then it requires this crates depends on reedline, this is not good because protocol should not rely on a cli relative interface.

Fields

value: String

String replacement that will be introduced to the the buffer

description: Option<String>

Optional description for the replacement

extra: Option<Vec<String>>

Optional vector of strings in the suggestion. These can be used to represent examples coming from a suggestion

append_whitespace: bool

Whether to append a space after selecting this suggestion. This helps to avoid that a completer repeats the complete suggestion.

match_indices: Option<Vec<usize>>

Indices of the graphemes in the suggestion that matched the typed text. Useful if using fuzzy matching.

span: Option<Span>

Replacement span in the buffer, if any.

kind: Option<SuggestionKind>

Trait Implementations

impl Clone for DynamicSuggestion

fn clone(&self) -> DynamicSuggestion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicSuggestion

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

Formats the value using the given formatter.

impl Default for DynamicSuggestion

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DynamicSuggestion

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DynamicSuggestion

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DynamicSuggestion