Struct icon_baker::Icon

pub struct Icon<'a> { /* fields omitted */ }

A generic representation of an icon.

Methods

impl<'a> Icon<'a>

pub fn new(icon_type: IconType, capacity: usize) -> Self

Creates an Icon instance.

Arguments

• icon_type The type of the returned icon.
• capacity The target capacity for the underliyng HashMap<IconOptions, &SourceImage>.

It is important to note that although the returned Icon has the capacity specified, the Icon will have zero entries. For an explanation of the difference between length and capacity, see Capacity and reallocation.

pub fn ico(capacity: usize) -> Self

Creates an Icon with the Ico icon type.

Arguments

• capacity The target capacity for the underliyng HashMap<IconOptions, &SourceImage>.

It is important to note that although the returned Icon has the capacity specified, the Icon will have zero entries. For an explanation of the difference between length and capacity, see Capacity and reallocation.

pub fn icns(capacity: usize) -> Self

Creates an Icon with the Icns icon type.

Arguments

• capacity The target capacity for the underliyng HashMap<IconOptions, &SourceImage>.

It is important to note that although the returned Icon has the capacity specified, the Icon will have zero entries. For an explanation of the difference between length and capacity, see Capacity and reallocation.

pub fn png_sequence(capacity: usize) -> Self

Creates an Icon with the PngSequece icon type.

Arguments

• capacity The target capacity for the underliyng HashMap<IconOptions, &SourceImage>.

It is important to note that although the returned Icon has the capacity specified, the Icon will have zero entries. For an explanation of the difference between length and capacity, see Capacity and reallocation.

pub fn add_entry(&mut self, opts: Entry, source: &'a SourceImage) -> Result<()>

Adds an entry to the icon.

Returns Err(Error::SizeAlreadyIncluded(Size)) if any of the sizes listed in opts.sizes() is already associated to another entry. Otherwise returns Ok(()).

pub fn remove_entry(&mut self, opts: &Entry) -> Option<&SourceImage>

Remove an entry from the icon.

Returns Some(&SourceImage) if the icon contains an entry associated with the opts argument. Returns None otherwise.

pub fn sizes(&self) -> Vec<Size>

Returns a list of all sizes listed in all icon's entries.

pub fn n_sizes(&self) -> usize

Returns the total number of sizes in all icon's entries.

This method avoids allocating unnecessary resources when accessing self.sizes().len().

pub fn raster(&self) -> Result<Vec<RgbaImage>>

pub fn write<W: Write + Seek>(&self, w: W) -> Result<()>

Writes the icon to a file or stream.

Trait Implementations

impl<'a> AsRef<HashMap<Entry, &'a SourceImage, RandomState>> for Icon<'a>

fn as_ref(&self) -> &HashMap<Entry, &'a SourceImage>

Performs the conversion.