Struct IconSpec 

pub struct IconSpec {
    pub glyph: Cow<'static, str>,
    pub font: Option<Font>,
    pub size: Option<f32>,
}

Description of how to render an icon for a particular IconRole.

Constructed by an IconTheme. The widget takes the spec and emits an iced text element using glyph, optionally setting the specified font and size. When font is None, the glyph renders in the default iced font. When size is None, the widget picks its own default (currently 14).

Use IconSpec::new + IconSpec::with_font / IconSpec::with_size for ergonomic construction:

let spec = IconSpec::new("\u{E89C}").with_size(16.0);
assert_eq!(spec.glyph.as_ref(), "\u{E89C}");

Fields are pub so const themes can construct specs literally — but note that adding fields here is a breaking change, so we don’t expect to add new fields before a hypothetical 2.0.

Fields

glyph: Cow<'static, str>

The text to render. A single char for typical icons; longer strings are supported (e.g. ligatures, emoji sequences, labels like "DIR").

Cow<'static, str> so themes can use &'static str literals at no allocation cost, while still accepting owned Strings for dynamically constructed glyphs.

font: Option<Font>

The font to render glyph in, or None for the iced default. Themes using icon-font packs (lucide-icons, Material Design Icons, …) must set this or the glyph codepoints will render as tofu.

size: Option<f32>

The point size to render at, or None to let the widget pick (currently 14). Themes using larger/smaller glyphs than the default can set this to match their intended visual balance.

Implementations

impl IconSpec

pub fn new(glyph: impl Into<Cow<'static, str>>) -> Self

Build a spec from a glyph string. Font and size are None by default — the widget will render in the iced default font at its default size.

Examples found in repository

examples/icon_theme.rs (line 51)

    fn glyph(&self, role: IconRole) -> IconSpec {
        // External theme → include a `_ =>` fallback for future
        // variants added in a minor release.
        let s: &'static str = match role {
            IconRole::FolderClosed => "[D]",
            IconRole::FolderOpen => "[O]",
            IconRole::File => "[F]",
            IconRole::Error => "[!]",
            IconRole::CaretRight => ">",
            IconRole::CaretDown => "v",
            _ => "?",
        };
        IconSpec::new(s)
    }
}

/// Custom theme: ultra-compact ASCII. Shows that a theme doesn't
/// need to pull in an icon font — plain text works fine if the
/// glyphs exist in the default system font.
#[derive(Debug)]
struct AsciiTheme;

impl IconTheme for AsciiTheme {
    fn glyph(&self, role: IconRole) -> IconSpec {
        let s: &'static str = match role {
            IconRole::FolderClosed => "+",
            IconRole::FolderOpen => "-",
            IconRole::File => ".",
            IconRole::Error => "!",
            IconRole::CaretRight => ">",
            IconRole::CaretDown => "v",
            _ => "?",
        };
        IconSpec::new(s)
    }

pub fn with_font(self, font: Font) -> Self

Set the font used to render the glyph. Required for icon-font packs where the codepoint is only valid in a specific font.

pub fn with_size(self, size: f32) -> Self

Set the point size. None (the default) means the widget picks — currently 14.

Trait Implementations

impl Clone for IconSpec

fn clone(&self) -> IconSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IconSpec

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

Formats the value using the given formatter.

impl PartialEq for IconSpec

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