Struct iconwriter::favicon::Favicon

pub struct Favicon { /* fields omitted */ }

A comprehensive favicon builder.

Implementations

impl Favicon

pub fn apple_touch(&mut self, b: bool) -> &mut Self

Indicates that the outputted html-helper should contain link tags for apple-touch icons.

This option defaults to false.

Example

let fav = Favicon::new().apple_touch(true);

<link rel="apple-touch-icon-precomposed" sizes="196x196" href="icons/favicon-0.png">
<link rel="icon" sizes="196x196" href="icons/favicon-0.png">

pub fn web_app(&mut self, b: bool) -> &mut Self

Indicates that the output of self.write or self.save should contain a manifest.webmanifest file to assist on creating PWA icons.

This option defaults to false.

Example

let fav = Favicon::new().web_app(true);

...
<link rel="manifest" href="manifest.webmanifest">

{
    icons: [
        {
            src: "icons/favicon-0.png",
            sizes: "196x196",
            type: "image/png"
        }
    ],
}

pub fn html_helper(&self) -> Result<Vec<u8>>

Returns a buffer containing HTML link tags to assist on the creating of the icon.

pub fn manifest(&self) -> Result<Vec<u8>>

Returns a buffer containing a JSON helper for web manisfests.

Trait Implementations

impl Clone for Favicon

pub fn clone(&self) -> Favicon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Icon for Favicon

type Key = Key

pub fn with_capacity(capacity: usize) -> Self

Constructs a new, empty Icon with the specified capacity. The capacity argument designates the number of entries that will be allocated.

pub fn len(&self) -> usize

Returns the number of entries contained in the icon.

pub fn add_entry<F: FnMut(&DynamicImage, u32) -> Result<DynamicImage>>(
    &mut self,
    filter: F,
    source: &Image,
    key: Self::Key
) -> Result<(), IconError<Self::Key>>

Adds an individual entry to the icon.

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

Writes the contents of the icon to w.

pub fn save<P: AsRef<Path>>(&mut self, base_path: &P) -> Result<()>

Writes the contents of the icon to a file on disk.

pub fn new() -> Self

Creates a new icon.

pub fn add_entries<F: FnMut(&DynamicImage, u32) -> Result<DynamicImage>, I: IntoIterator<Item = Self::Key>>(
    &mut self,
    filter: F,
    source: &Image,
    keys: I
) -> Result<(), IconError<Self::Key>>

Adds a series of entries to the icon.