Struct IconCache

pub struct IconCache<'a> {
    pub bytes: &'a [u8],
    pub header: &'a Header,
    pub hash: &'a Hash,
    pub directory_list: DirectoryList<'a>,
}

Thin wrapper around an in-memory icon cache.

This is icon-cache’s main entrypoint. To look up an icon, use the icon function.

IconCache’s fields may be interesting for advanced uses, but if all you need is to look up icons—use icon.

Fields

bytes: &'a [u8]

The raw bytes representing the cache

header: &'a Header

Cache header file: contains version and hash & directory list offsets

hash: &'a Hash

Internal hash table storing mapping from icon names to icon information

directory_list: DirectoryList<'a>

List of directories within the theme, relative to the theme’s root

Implementations

impl<'a> IconCache<'a>

pub fn new_from_bytes(bytes: &'a [u8]) -> Result<Self, Box<dyn Error + 'a>>

pub fn icon(&self, icon_name: impl AsRef<[u8]>) -> Option<Icon<'a>>

Look up an icon by name in the cache. icon_name accepts any type that turns into a byte slice: typically str suffices.

Returns None if no icon by that name exists within the icon theme, or if parsing failed.

pub fn iter(&self) -> impl Iterator<Item = Icon<'a>>

Trait Implementations

impl<'a> Clone for IconCache<'a>

fn clone(&self) -> IconCache<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for IconCache<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for IconCache<'a>