Struct IconShortcode 

pub struct IconShortcode {
    pub full_text: String,
    pub prefix: String,
    pub name_parts: Vec<String>,
    pub start: usize,
    pub end: usize,
}

Parsed icon shortcode information

Fields

full_text: String

The full shortcode text including colons (e.g., :material-check:)

prefix: String

The icon set prefix (e.g., material, octicons)

name_parts: Vec<String>

The icon name parts after the prefix (e.g., ["check"] or ["mark", "github", "16"])

start: usize

Start position in the line (0-indexed)

end: usize

End position in the line (0-indexed, exclusive)

Implementations

impl IconShortcode

pub fn full_name(&self) -> String

Get the full icon name (prefix + name parts joined with hyphens)

pub fn is_known_icon_set(&self) -> bool

Check if this is a known MkDocs icon set

Trait Implementations

impl Clone for IconShortcode

fn clone(&self) -> IconShortcode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IconShortcode

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

Formats the value using the given formatter.

impl PartialEq for IconShortcode

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