Struct Candidate 

pub struct Candidate {
    pub key: String,
    pub insert: String,
    pub reference: Option<String>,
    pub name: String,
    pub handle: Option<String>,
    pub aside: Option<String>,
    pub label: Option<String>,
    pub icon: Option<Icon>,
    pub person: Option<SuggestionPerson>,
    pub command: Option<Command>,
}

One thing a completion offers: how it reads in the drawer and what a pick writes.

Fields

key: String

What identifies it across tiers and keystrokes: its reference, or its text.

insert: String

What a pick writes in place of the token: the inline view’s text (@Ada Lovelace, #general, an emoji).

reference: Option<String>

The reference a pick names, for a field that keeps rich text (the mention mark’s value). None writes plain text.

name: String

The name matched and shown, its matched letters bold.

handle: Option<String>

A second name it is found by, shown dim after the name: a handle, a shortcode.

aside: Option<String>

A line about it, shown dim after the name: a channel’s topic, a command’s description.

label: Option<String>

A label on the row’s trailing side: “in this channel”, a role, an unread count.

icon: Option<Icon>

person: Option<SuggestionPerson>

The participant it names, shown as their avatar.

command: Option<Command>

The command it runs, for a / source.

Implementations

impl Candidate

pub fn reference( name: impl Into<String>, insert: impl Into<String>, reference: impl Into<String>, ) -> Candidate

A candidate named name that writes insert and names reference.

pub fn text(name: impl Into<String>, insert: impl Into<String>) -> Candidate

A candidate that writes insert as plain text, shown as name.

pub fn with_handle(self, handle: impl Into<String>) -> Candidate

pub fn with_aside(self, aside: impl Into<String>) -> Candidate

pub fn with_label(self, label: impl Into<String>) -> Candidate

pub fn with_icon(self, icon: Icon) -> Candidate

pub fn with_person(self, person: SuggestionPerson) -> Candidate

pub fn with_command(self, command: Command) -> Candidate

Trait Implementations

impl Clone for Candidate

fn clone(&self) -> Candidate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Candidate

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

Formats the value using the given formatter.

impl Default for Candidate

fn default() -> Candidate

Returns the “default value” for a type.

impl PartialEq for Candidate

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

impl StructuralPartialEq for Candidate