Skip to main content

RawCandidate

Type Alias RawCandidate 

Source
pub type RawCandidate = RawCandidate;

Aliased Type§

pub struct RawCandidate {
    pub text: String,
    pub insert_text: Option<String>,
    pub display: String,
    pub source: Option<String>,
    pub kind: CandidateKind,
    pub data: CandidateData,
    pub annotations: Vec<Annotation>,
    pub display_spans: Vec<DisplaySpan>,
}

Fields§

§text: String§insert_text: Option<String>

OR.7: what to insert on accept when that differs from the text the query matched. none ⇒ insert text. A completion source that offers a human-readable label but inserts machine syntax (org-roam offering a node title and inserting an [[id:…][…]] link) needs both, and matching against the machine syntax instead would score every candidate on its id.

§display: String§source: Option<String>§kind: CandidateKind§data: CandidateData§annotations: Vec<Annotation>§display_spans: Vec<DisplaySpan>

PS.1: styled runs over display. Empty for every source that does not style itself, which is the pre-PS.1 behaviour exactly.