Struct favy::Favicon

pub struct Favicon { /* fields omitted */ }

A comprehensive favicon encoder.

Example

use favy::{resample, encode::Encode, Image, Favicon, Size};
 
fn main() -> io::Result<()> {
    // Initialize the icon
    let mut icon = Favicon::new();
 
    // Add a single entry
    let image = Image::open("example.png")?;
    icon.add_entry(resample::linear, &image, Size(32))?;
 
    // Add multiple entries
    icon.add_entries(
        resample::linear,
        &image,
        vec![Size(64), Size(128), Size(256)]
    )?;
 
    // Save the icon to disk
    icon.save("~/favicon/")
}

Methods

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/favicon0.png">
<link rel="icon" sizes="196x196" href="icons/favicon0.png">

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

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

This option defaults to false.

Example

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

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

{
  icons: [
    {
      src: "icons/favicon0.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 manisfest(&self) -> Result<Vec<u8>>

Returns a buffer containing a JSON helper for web manisfests.

Trait Implementations

impl Clone for Favicon

fn clone(&self) -> Favicon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Favicon

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Encode for Favicon

type Key = Size

fn with_capacity(capacity: usize) -> Self

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

fn len(&self) -> usize

Returns the number of entries contained in the icon.

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

Adds an individual entry to the icon.

fn new() -> Self

Creates a new icon.

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

Adds a series of entries to the icon.

impl Save for Favicon

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

Writes the contents of the icon to disk.