Struct identicon_rs::Identicon

pub struct Identicon { /* private fields */ }

Generic Identicon struct

This is the base struct to be used.

Implementations

impl Identicon

pub fn new<T>(input_value: T) -> Self where
    T: AsRef<str>, 

Generates a new identicon

The defaults are:

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

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

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 5x5

pub fn scale(&self) -> u32

Gets the identicon scale

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

Sets the scale of the image.

The scale plus 2 times the border is the final pixel size of the image.

This must be >= the size.

Default is 500

pub fn background_color(&self) -> (u8, u8, u8)

Gets the identicon background color

pub fn set_background_color(
    &mut self,
    background_color: (u8, u8, u8)
) -> &mut Self

Sets the background, non-active color of the identicon.

This is a tuble of (red, green, blue) values.

Default is (240, 240, 240)

pub fn mirrored(&mut 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.

Default is true

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

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

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 copy of the value.

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

Performs copy-assignment from source.

impl Debug for Identicon

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

Formats the value using the given formatter.

impl Hash for Identicon

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Identicon

fn cmp(&self, other: &Identicon) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Identicon> for Identicon

fn eq(&self, other: &Identicon) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Identicon) -> bool

This method tests for !=.

impl PartialOrd<Identicon> for Identicon

fn partial_cmp(&self, other: &Identicon) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Identicon

impl StructuralEq for Identicon

impl StructuralPartialEq for Identicon