Enum HelpLinkTarget 

pub enum HelpLinkTarget {
    Command(String),
    Chord(String),
    Source {
        path: PathBuf,
        line: u32,
    },
    Topic(String),
    Anchor(String),
    Execute(String),
    Customize(String),
    CustomizeEdit(String),
    Mode(String),
    Url(String),
    Unresolved(String),
}

What a [[…]] link points at. Renderers / link-following motions dispatch on this.

Variants

Command(String)

[[command:NAME]] – re-dispatches :describe-command NAME.

Chord(String)

[[key:CHORD]] – re-dispatches :describe-key CHORD.

Source

[[file:PATH:LINE]] – opens PATH at LINE.

Fields

path: PathBuf

line: u32

Topic(String)

[[help:TOPIC]] – re-dispatches :help TOPIC. Used by :describe-* cross-references and by topic body content itself so a topic can link to a sibling topic.

Anchor(String)

[label](#slug) – intra-document jump. Auto-generated from markdown headings (GitHub-style slug: lowercase, non-alnum runs collapsed to -, leading/trailing - trimmed). The follow-link handler scrolls the current help buffer to the matching anchor’s line; no buffer swap.

Execute(String)

[label](exec:CMDLINE) – executes the cmdline as if the user had typed :CMDLINE<CR>. Distinct from Self::Command which describes the command instead of running it. Used by picker-style help buffers (e.g. :lsp-server-log) where each row’s link should fire the real command on Enter, not surface its docs.

The payload is the full cmdline (command + args, no leading colon). Multi-arg commands like lsp-log rust pass through verbatim.

Customize(String)

[label](customize:NAME) – re-dispatches :customize NAME (M.9.1). Used by the customize picker so each group / mode row in the no-args view follows to its own focused buffer on <CR>.

CustomizeEdit(String)

[label](customize-edit:NAME) – prefills the cmdline with :set NAME=<current-value> and enters Command mode (M.9.2). Used by the customize buffer’s per-row links so <CR> on an option row opens an inline edit. The actual write goes through the existing :set machinery, so validation, cascade, and event-bus publishing all run unchanged.

Mode(String)

[label](mode:NAME) – re-dispatches :describe-mode NAME. Used by :describe-buffer (the “modes active here” section) so each mode name in the list is clickable; follow-link pushes a position-history entry so <C-o> walks back into the originating help buffer.

Url(String)

[label](URL) where URL carries a real network / app scheme (http://, https://, mailto:, or any scheme://… such as slack://, vscode://). Follow-link hands it to the OS handler (open / xdg-open / explorer) so the default browser / app opens it. Distinct from Self::Source (file: → open in-editor) and Self::Unresolved (no handler).

Unresolved(String)

[[…]] whose payload didn’t match a known scheme. Preserved verbatim for forward-compat – a plugin / future scheme can inspect the raw payload.

Trait Implementations

impl Clone for HelpLinkTarget

fn clone(&self) -> HelpLinkTarget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelpLinkTarget

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

Formats the value using the given formatter.

impl Eq for HelpLinkTarget

impl PartialEq for HelpLinkTarget

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HelpLinkTarget