pub struct IconFamily {
    pub elements: Vec<IconElement>,
}
Expand description

A set of icons stored in a single ICNS file.

Fields

elements: Vec<IconElement>

The icon elements stored in the ICNS file.

Implementations

Creates a new, empty icon family.

Returns true if the icon family contains no icons nor any other elements.

Encodes the image into the family, automatically choosing an appropriate icon type based on the dimensions of the image. Returns an error if there is no supported icon type matching the image dimensions.

Encodes the image into the family using the given icon type. If the selected type has an associated mask type, the image mask will also be added to the family. Returns an error if the image has the wrong dimensions for the selected type.

Returns a list of all (non-mask) icon types for which the icon family contains the necessary element(s) for a complete icon image (including alpha channel). These icon types can be passed to the get_icon_with_type method to decode the icons.

Determines whether the icon family contains a complete icon with the given type (including the mask, if the given icon type has an associated mask type).

Decodes an image from the family with the given icon type. If the selected type has an associated mask type, the two elements will decoded together into a single image. Returns an error if the element(s) for the selected type are not present in the icon family, or the if the encoded data is malformed.

Reads an icon family from an ICNS file.

Writes the icon family to an ICNS file.

Returns the encoded length of the file, in bytes, including the length of the header.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.