Struct IconSet 

pub struct IconSet { /* private fields */ }

The icons available to a running application: the framework’s set plus what modules contributed.

Implementations

impl IconSet

pub fn new() -> Self

The framework’s own set.

pub fn add(&mut self, owner: &str, reg: &IconReg) -> Result<String, IconError>

Adds a module’s own icon, namespaced to it.

The key becomes {owner}:{name}, so a bare name stays reserved to the framework and two modules cannot collide however they name things.

pub fn has(&self, name: &str) -> bool

Whether a name resolves.

pub fn body(&self, name: &str) -> Option<&str>

The drawing instructions for a name.

pub fn len(&self) -> usize

How many icons are available.

pub fn is_empty(&self) -> bool

Whether the set is empty, which it never is in practice.

pub fn nearest(&self, name: &str, limit: usize) -> Vec<&str>

Names closest to name, for telling an author what they probably meant.

Substring matches first, then names sharing a leading word, which between them catch the mistakes people actually make: a near-miss (user for users) and a wrong suffix (chart-bars for chart-bar).

pub fn sprite(&self) -> String

Every icon as one SVG sprite, for serving at a single cached URL.

A symbol carries viewBox and nothing else. A presentation attribute here would beat whatever the use site inherits and could not be reached by page CSS, so stroke, fill and caps stay on the outer element where a consumer can restyle them.

pub fn use_ref( &self, name: &str, sprite_url: &str, label: Option<&str>, ) -> Option<String>

A reference into the sprite: two nodes and about seventy bytes, against the few hundred an inlined glyph costs every time it renders.

Decorative by default, for the same reason as IconSet::inline.

pub fn inline(&self, name: &str, label: Option<&str>) -> Option<String>

Inline SVG for a name, for a context that cannot fetch a sprite.

Decorative by default: a screen reader skips it, because an icon beside a label repeats the label. Pass a label only when the icon is the whole meaning, and prefer naming the button around it.

Trait Implementations

impl Default for IconSet

fn default() -> Self

Returns the “default value” for a type.