Struct IconDefinition 

pub struct IconDefinition {
    pub classic: String,
    pub nerdfont: Option<String>,
}

A single icon definition with classic and optional Nerd Font variants.

The classic variant is always required and works in all terminals. The Nerd Font variant is optional and used when the terminal has a Nerd Font installed.

Icons can be N characters long, though they are typically a single character.

Example

use standout_render::{IconDefinition, IconMode};

// Classic-only icon
let icon = IconDefinition::new("⚪");
assert_eq!(icon.resolve(IconMode::Classic), "⚪");
assert_eq!(icon.resolve(IconMode::NerdFont), "⚪"); // Falls back to classic

// Icon with Nerd Font variant
let icon = IconDefinition::new("⚫").with_nerdfont("\u{f00c}");
assert_eq!(icon.resolve(IconMode::Classic), "⚫");
assert_eq!(icon.resolve(IconMode::NerdFont), "\u{f00c}");

Fields

classic: String

Classic variant (always required). Works in all terminals.

nerdfont: Option<String>

Nerd Font variant (optional). Used when Nerd Font is available.

Implementations

impl IconDefinition

pub fn new(classic: impl Into<String>) -> Self

Creates a new icon definition with a classic variant.

pub fn with_nerdfont(self, nerdfont: impl Into<String>) -> Self

Adds a Nerd Font variant to this icon definition.

pub fn resolve(&self, mode: IconMode) -> &str

Resolves the icon string for the given mode.

In NerdFont mode, returns the Nerd Font variant if available, otherwise falls back to the classic variant.

In Classic or Auto mode, always returns the classic variant.

Trait Implementations

impl Clone for IconDefinition

fn clone(&self) -> IconDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IconDefinition

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

Formats the value using the given formatter.

impl PartialEq for IconDefinition

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

impl StructuralPartialEq for IconDefinition