Struct initials::avatar::AvatarBuilder

pub struct AvatarBuilder {
    pub name: String,
    pub font_data: Vec<u8>,
    pub font_scale: Scale,
    pub font_color: Vec<i64>,
    pub background_color: Vec<i64>,
    pub length: usize,
    pub width: u32,
    pub height: u32,
    pub contrast_ratio: f32,
    /* private fields */
}

Avatar builder that stores the metrics of the image.

Fields

name: String

Initials name string

font_data: Vec<u8>

Vectorized font data

font_scale: Scale

Scale of the font

font_color: Vec<i64>

RGB color of the font

background_color: Vec<i64>

RGB color of the background

length: usize

Size of the inner-text

width: u32

Width of the avatar

height: u32

Height of the avatar

contrast_ratio: f32

Contrast ratio for the colors

Implementations

impl AvatarBuilder

pub fn new(name: &str) -> AvatarBuilder

Construct new AvatarBuilder.

pub fn with_font(self, font: &str) -> AvatarResult

Change the font of the avatar text. You need to include .ttf file. Default style is Hiragino_Sans.

pub fn with_font_color(self, color: &str) -> AvatarResult

Change the font color. You need to specify hex color code.

pub fn with_font_scale(self, scale: f32) -> AvatarResult

Change the uniform scale of font. Default to 150.0.

pub fn with_background_color(self, color: &str) -> AvatarResult

Change the background color of the avatar. You need to specify hex color code.

pub fn with_length(self, length: usize) -> AvatarResult

Change the length of initials characters taken from the name. Default to 2.

pub fn with_width(self, width: u32) -> AvatarResult

Change the width of the avatar. Default to 300.

pub fn with_height(self, height: u32) -> AvatarResult

Change the height of the avatar. Default to 300.

pub fn with_contrast_ratio(self, ratio: f32) -> AvatarResult

Change the contrast ratio for the randomly generated avatar. Default to 4.5. Increase the ratio for more clear avatar.

pub fn draw(self) -> ImageBuffer<Rgba<u8>, Vec<u8>>

Draw the image according to the metrics given.

Trait Implementations

impl Debug for AvatarBuilder

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

Formats the value using the given formatter.