Struct SymbolIcon 

pub struct SymbolIcon { /* private fields */ }

A symbol, visual style, and validated set of variation coordinates.

Implementations

impl Icon

pub fn component(self) -> Icon

A themed Longbridge component icon, respecting Kit sizing and icon resolution. Register MaterialSymbols before rendering path-based icons.

Path-based icons are not validated here: an SVG-only symbol with axes that Icon::is_supported rejects loads with an error and renders empty. Use Self::embedded to surface that error at construction time.

pub fn embedded(self) -> Result<Icon, Error>

A component icon with embedded SVG data; no asset source registration needed. Invalid discrete variants fail immediately. Raw data bypasses Kit’s path resolver.

pub fn svg(self) -> Svg

Return the raw SVG primitive from the same backend as GPUI Kit. Register MaterialSymbols on the application before rendering.

impl Icon

pub fn new(symbol: Symbol) -> Icon

Create an outlined symbol with default axes.

pub fn style(self, style: Style) -> Icon

Choose a visual style.

pub fn axes(self, axes: Axes) -> Icon

Set all variable axes.

pub fn filled(self, filled: bool) -> Icon

Select the filled or unfilled state without changing other axes.

pub fn symbol(self) -> Symbol

The selected symbol.

pub fn visual_style(self) -> Style

The selected visual style.

pub fn variations(self) -> Axes

The selected axes.

pub fn asset_path(self) -> String

A deterministic, namespaced asset path including every variation coordinate.

pub fn from_asset_path(path: &str) -> Result<Icon, Error>

Decode an asset path. Noncanonical and malformed paths are rejected.

pub fn required_asset(self) -> Asset

The asset Icon::to_svg reads: the style’s font, or the SVG pack for SVG-only symbols.

pub fn is_supported(self) -> bool

Whether this exact style and axis combination is available upstream.

pub fn to_svg(self) -> Result<String, Error>

Convert the variable glyph outline to an SVG, preserving the full em square.

The SVG uses black geometry so GPUI’s monochrome SVG tinting works naturally. No OS font registration, network access, or filesystem access is needed.

Trait Implementations

impl Clone for Icon

fn clone(&self) -> Icon

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Icon

impl Debug for Icon

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

Formats the value using the given formatter.

impl From<Icon> for Icon

fn from(icon: SymbolIcon) -> Self

Converts to this type from the input type.

impl IconNamed for Icon

fn path(self) -> SharedString

impl PartialEq for Icon

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Icon