Struct SlugEntry 

pub struct SlugEntry {
    pub canonical: &'static str,
    pub family: SlugFamily,
    pub accepts_param: bool,
    pub doc: &'static str,
    pub partner: Option<&'static str>,
    pub wrapper: PairKind,
}

One row of the slug catalogue.

Fields

canonical: &'static str

Canonical body text (without the surrounding ［＃ / ］).

family: SlugFamily

Coarse category / family.

accepts_param: bool

Whether the slug expects a numeric parameter (or, for Sashie, a path) following the canonical text.

doc: &'static str

Short Japanese description shown in LSP CompletionItem.detail / documentation fields. Single sentence, no surrounding punctuation, terminating period.

partner: Option<&'static str>

For BlockContainerOpen / BlockContainerClose slugs, the canonical text of the partner slug — so the editor can link them together (insert close on accept, jump to partner, …). None for non-paired families.

wrapper: PairKind

Always PairKind::Bracket for the slugs in this table — the surrounding ［＃ … ］ is a bracket pair. Carried so editor snippets can render the wrapper bracket pair without having to re-derive it.

Trait Implementations

impl Clone for SlugEntry

fn clone(&self) -> SlugEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SlugEntry

impl Debug for SlugEntry

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

Formats the value using the given formatter.