Enum CandidateData 

pub enum CandidateData {
    Command {
        name: String,
        doc: String,
        kind_label: String,
        source: SourceLocation,
    },
    File {
        path: PathBuf,
        is_dir: bool,
        size: Option<u64>,
    },
    Option {
        name: String,
        current_value: String,
        doc: String,
    },
    OptionValue {
        option_name: String,
        value: String,
        doc: String,
    },
    Chord {
        chord: String,
        mode_label: String,
        doc: String,
    },
    Register {
        name: char,
        preview: String,
    },
    Mark {
        name: char,
        position: String,
    },
    Plain,
    Extension {
        kind_id: u32,
        payload: Vec<u8>,
    },
}

Generator-supplied metadata travelling alongside the candidate. Annotators read this to produce display text without re-querying the underlying registry. Plugin generators stash their own payload in Extension (msgpack on the wire when WASM lands).

Variants

Command

gen:commands payload: command’s full metadata at the time of generation.

Fields

name: String

doc: String

kind_label: String

source: SourceLocation

File

gen:files payload.

Fields

path: PathBuf

is_dir: bool

size: Option<u64>

Option

gen:options payload (typed options post-§5.12). Emitted for option-name completion (:set <Tab>). doc is OptionDecl::DOC.

Fields

name: String

current_value: String

doc: String

OptionValue

gen:options payload — value-completion mode. Slice 3c.unify.option-doc-annotator. Emitted for :set foo=<Tab> when the option’s OptionType::enumerate returns Some. doc is EnumeratedValue::doc — per-value help text the type chose to surface (empty when the type hasn’t overridden enumerate_with_docs).

Fields

option_name: String

value: String

doc: String

Chord

gen:chords payload.

Fields

chord: String

mode_label: String

doc: String

Register

gen:registers payload.

Fields

name: char

preview: String

Mark

gen:marks payload.

Fields

name: char

position: String

Plain

Generator that needs no extra metadata (text alone is enough).

Extension

Plugin-defined arbitrary payload. The pipeline preserves it unchanged through matcher / ranker; annotators registered by the same plugin recognise the kind_id and decode payload.

Fields

kind_id: u32

payload: Vec<u8>

Trait Implementations

impl Clone for CandidateData

fn clone(&self) -> CandidateData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CandidateData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CandidateData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CandidateData

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CandidateData

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 CandidateData