Struct iconwriter::Icon

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

A generic representation of an icon.

Implementations

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 sizes. 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 sizes. 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 sizes. 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 sizes. For an explanation of the difference between length and capacity, see Capacity and reallocation.

pub fn add_size(&mut self, size: Size, source: &'a SourceImage) -> Result<()>

Adds a size binding to the icon.

Returns Err(_) if the specified size is invalid or is already included in the Icon. Returns Ok(()) otherwise.

pub fn add_sizes<I: ExactSizeIterator<Item = Size>>(
    &mut self,
    sizes: I,
    source: &'a SourceImage
) -> Result<()>

Adds a series sizes binding to the icon.

Returns Err(_) if any of the specified sizes is invalid or is already included in the Icon. Returns Ok(()) otherwise.

pub fn remove_size(&mut self, size: Size) -> Option<&SourceImage>

Remove a size binding from the icon.

Returns Some(&SourceImage) if the icon contains a size binding 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 sizes.

pub fn n_sizes(&self) -> usize

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

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

pub fn contains_size(&self, size: Size) -> bool

Returns true if self.source_map contains size. Otherwise returns false.

This method avoids allocating unnecessary resources when accessing self.sizes().includes(&size).

pub fn rasterize<F: FnMut(&SourceImage, Size) -> Result<RgbaImage>>(
    &self,
    resampler: F
) -> Result<Vec<RgbaImage>>

pub fn write<W: Write, F: FnMut(&SourceImage, Size) -> Result<RgbaImage>>(
    &self,
    w: W,
    resampler: F
) -> Result<()>

Writes the icon to a file or stream.

Trait Implementations

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

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

Performs the conversion.