Struct ConfigKeySpec 

pub struct ConfigKeySpec {
    pub key: String,
    pub tooltip: Option<String>,
    pub value_suggestions: Vec<SuggestionEntry>,
}

Declarative config set key metadata used for completion nodes.

Fields

key: String

Config key name completed below config set.

tooltip: Option<String>

Optional description shown for the key.

value_suggestions: Vec<SuggestionEntry>

Suggested values for the key.

Implementations

impl ConfigKeySpec

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

Creates a config key spec with the given key name.

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

Sets the display tooltip for this config key.

If omitted, completion UIs show no description for the key.

pub fn value_suggestions( self, suggestions: impl IntoIterator<Item = SuggestionEntry>, ) -> Self

Replaces the suggested values for this config key.

If omitted, the key contributes no value suggestions.

Trait Implementations

impl Clone for ConfigKeySpec

fn clone(&self) -> ConfigKeySpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigKeySpec

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

Formats the value using the given formatter.

impl Default for ConfigKeySpec

fn default() -> ConfigKeySpec

Returns the “default value” for a type.

impl PartialEq for ConfigKeySpec

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

impl StructuralPartialEq for ConfigKeySpec