Struct Identicon 

pub struct Identicon { /* private fields */ }

Generic Identicon struct.

This is the base struct to be used.

Implementations

impl Identicon

pub fn new(input_value: &str) -> Identicon

Generates a new identicon from an input value.

The defaults are:

• border: 50
• size: 5
• scale: 500
• background_color: (240, 240, 240)
• mirrored: true

pub fn set_input(&mut self, input_value: &str) -> &mut Self

Sets the identicon input value, regenerating the hash.

pub fn border(&self) -> u32

Gets the identicon border size.

pub fn set_border(&mut self, border: u32) -> &mut Self

Sets the identicon border size.

Default is 5

pub fn size(&self) -> u32

Gets the identicon size.

The size represents the number of viewable blocks of the identicon.

pub fn set_size(&mut self, size: u32) -> Result<&mut Self, IdenticonError>

Sets the number of viewable blocks of the identicon.

This must be <= the scale.

Default is 5, representing an identicon with a grid of 5x5.

pub fn scale(&self) -> u32

Gets the identicon scale.

The scale represents the height and width of the identicon portion of any generated image.

The full image size is: scale + ( 2 * border )

pub fn set_scale(&mut self, scale: u32) -> Result<&mut Self, IdenticonError>

Sets the scale of the image.

The full image size is: scale + ( 2 * border )

This must be >= the size.

pub fn mirrored(&self) -> bool

Gets if the identicon is mirrored.

pub fn set_mirrored(&mut self, mirrored: bool) -> &mut Self

Sets whether the identicon is mirrored along the y axis.

This is a boolean.

pub fn theme(&self) -> Arc<dyn Theme>

Gets the current theme.

pub fn set_theme(&mut self, theme: Arc<dyn Theme + Send + Sync>) -> &mut Self

Sets the current identicon theme.

pub fn generate_image(&self) -> Result<DynamicImage, IdenticonError>

Generates the DynamicImage representing the Identicon.

pub fn save_image(&self, output_filename: &str) -> Result<(), IdenticonError>

Saves the generated image to the given filename.

The file formats .png, .jpg, .jpeg, .bmp, and .ico work.

pub fn export_png_data(&self) -> Result<Vec<u8>, IdenticonError>

Export a PNG file buffer as a Vec<u8>.

This is for creating a file for a buffer or network response without creating a file on the filesystem.

pub fn export_jpeg_data(&self) -> Result<Vec<u8>, IdenticonError>

Export a JPEG file buffer as a Vec<u8>.

This is for creating a file for a buffer or network response without creating a file on the filesystem.

Trait Implementations

impl Clone for Identicon

fn clone(&self) -> Identicon

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Identicon

fn default() -> Self

Returns the “default value” for a type.

impl FromStr for Identicon

type Err = IdenticonError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.