hashavatar 1.1.0

Stable deterministic procedural avatars in Rust with configurable identity hashing, WebP, optional PNG/JPEG/GIF, and SVG export
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

use super::*;

/// Cat-face avatar renderer built from simple geometric primitives.
///
/// The face is intentionally stylized:
/// - a rounded head ellipse defines the main silhouette
/// - two ear polygons make the head read as feline rather than circular
/// - wide-set eyes, a small triangular nose, whiskers, and a curved smile complete the expression
#[derive(Clone, Copy, Debug, Default)]
pub struct CatAvatar;

impl AvatarRenderer for CatAvatar {
    fn render(&self, spec: AvatarSpec) -> Result<RgbaImage, AvatarSpecError> {
        render_cat_avatar(spec)
    }
}

/// Cat-face avatar renderer driven by a stable identity digest.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct HashedCatAvatar {
    identity: AvatarIdentity,
}

impl HashedCatAvatar {
    pub fn new<T: AsRef<[u8]>>(input: T) -> Result<Self, AvatarIdentityError> {
        Self::new_with_namespace(AvatarNamespace::default(), input)
    }

    pub fn new_with_namespace<T: AsRef<[u8]>>(
        namespace: AvatarNamespace<'_>,
        input: T,
    ) -> Result<Self, AvatarIdentityError> {
        Ok(Self {
            identity: AvatarIdentity::new_with_namespace(namespace, input)?,
        })
    }

    pub fn new_with_identity_options<T: AsRef<[u8]>>(
        options: AvatarIdentityOptions<'_>,
        input: T,
    ) -> Result<Self, AvatarIdentityError> {
        Ok(Self {
            identity: AvatarIdentity::new_with_options(options, input)?,
        })
    }

    /// Returns the avatar identity.
    ///
    /// # Security
    ///
    /// The returned identity may be derived from sensitive caller input.
    /// Keep borrowed or cloned identities short-lived in high-assurance
    /// deployments.
    pub fn identity(&self) -> &AvatarIdentity {
        &self.identity
    }
}

impl AvatarRenderer for HashedCatAvatar {
    fn render(&self, spec: AvatarSpec) -> Result<RgbaImage, AvatarSpecError> {
        render_cat_avatar_for_identity(spec, &self.identity)
    }
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct HashedDogAvatar {
    identity: AvatarIdentity,
    background: AvatarBackground,
}

impl HashedDogAvatar {
    pub fn new<T: AsRef<[u8]>>(
        input: T,
        background: AvatarBackground,
    ) -> Result<Self, AvatarIdentityError> {
        Self::new_with_namespace(AvatarNamespace::default(), input, background)
    }

    pub fn new_with_namespace<T: AsRef<[u8]>>(
        namespace: AvatarNamespace<'_>,
        input: T,
        background: AvatarBackground,
    ) -> Result<Self, AvatarIdentityError> {
        Ok(Self {
            identity: AvatarIdentity::new_with_namespace(namespace, input)?,
            background,
        })
    }

    pub fn new_with_identity_options<T: AsRef<[u8]>>(
        options: AvatarIdentityOptions<'_>,
        input: T,
        background: AvatarBackground,
    ) -> Result<Self, AvatarIdentityError> {
        Ok(Self {
            identity: AvatarIdentity::new_with_options(options, input)?,
            background,
        })
    }

    /// Returns the avatar identity.
    ///
    /// # Security
    ///
    /// The returned identity may be derived from sensitive caller input.
    /// Keep borrowed or cloned identities short-lived in high-assurance
    /// deployments.
    pub fn identity(&self) -> &AvatarIdentity {
        &self.identity
    }
}

impl AvatarRenderer for HashedDogAvatar {
    fn render(&self, spec: AvatarSpec) -> Result<RgbaImage, AvatarSpecError> {
        render_dog_avatar_for_identity(spec, &self.identity, self.background)
    }
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct HashedRobotAvatar {
    identity: AvatarIdentity,
    background: AvatarBackground,
}

impl HashedRobotAvatar {
    pub fn new<T: AsRef<[u8]>>(
        input: T,
        background: AvatarBackground,
    ) -> Result<Self, AvatarIdentityError> {
        Self::new_with_namespace(AvatarNamespace::default(), input, background)
    }

    pub fn new_with_namespace<T: AsRef<[u8]>>(
        namespace: AvatarNamespace<'_>,
        input: T,
        background: AvatarBackground,
    ) -> Result<Self, AvatarIdentityError> {
        Ok(Self {
            identity: AvatarIdentity::new_with_namespace(namespace, input)?,
            background,
        })
    }

    pub fn new_with_identity_options<T: AsRef<[u8]>>(
        options: AvatarIdentityOptions<'_>,
        input: T,
        background: AvatarBackground,
    ) -> Result<Self, AvatarIdentityError> {
        Ok(Self {
            identity: AvatarIdentity::new_with_options(options, input)?,
            background,
        })
    }

    /// Returns the avatar identity.
    ///
    /// # Security
    ///
    /// The returned identity may be derived from sensitive caller input.
    /// Keep borrowed or cloned identities short-lived in high-assurance
    /// deployments.
    pub fn identity(&self) -> &AvatarIdentity {
        &self.identity
    }
}

impl AvatarRenderer for HashedRobotAvatar {
    fn render(&self, spec: AvatarSpec) -> Result<RgbaImage, AvatarSpecError> {
        render_robot_avatar_for_identity(spec, &self.identity, self.background)
    }
}