twilight_model/user/current_user.rs
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 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
use super::{DiscriminatorDisplay, PremiumType, UserFlags};
use crate::{
id::{marker::UserMarker, Id},
util::image_hash::ImageHash,
};
use serde::{Deserialize, Serialize};
#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
pub struct CurrentUser {
/// Accent color of the user's banner.
///
/// This is an integer representation of a hexadecimal color code.
pub accent_color: Option<u32>,
/// User's avatar hash.
///
/// To retrieve the url to the avatar, see [Discord Docs/Image Formatting].
///
/// [Discord Docs/Image Formatting]: https://discord.com/developers/docs/reference#image-formatting
pub avatar: Option<ImageHash>,
/// Hash of the user's banner image.
pub banner: Option<ImageHash>,
/// Whether the user belongs to an OAuth2 application.
#[serde(default)]
pub bot: bool,
/// Discriminator used to differentiate people with the same username.
///
/// # Formatting
///
/// Because discriminators are stored as an integer they're not in the
/// format of Discord user tags due to a lack of padding with zeros. The
/// [`discriminator`] method can be used to retrieve a formatter to pad the
/// discriminator with zeros.
///
/// # serde
///
/// The discriminator field can be deserialized from either a string or an
/// integer. The field will always serialize into a string due to that being
/// the type Discord's API uses.
///
/// [`discriminator`]: Self::discriminator
#[serde(with = "super::discriminator")]
pub discriminator: u16,
/// User's email address associated to the account.
///
/// Requires the `email` oauth scope. See [Discord Docs/User Object].
///
/// [Discord Docs/User Object]: https://discord.com/developers/docs/resources/user#user-object-user-structure
#[serde(skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
/// All flags on a user's account.
#[serde(skip_serializing_if = "Option::is_none")]
pub flags: Option<UserFlags>,
/// User's id.
pub id: Id<UserMarker>,
/// User's chosen language option.
#[serde(skip_serializing_if = "Option::is_none")]
pub locale: Option<String>,
/// Whether the user has two factor enabled on their account.
pub mfa_enabled: bool,
/// User's username, not unique across the platform.
#[serde(rename = "username")]
pub name: String,
/// Type of Nitro subscription on a user's account.
#[serde(skip_serializing_if = "Option::is_none")]
pub premium_type: Option<PremiumType>,
/// Public flags on a user's account.
#[serde(skip_serializing_if = "Option::is_none")]
pub public_flags: Option<UserFlags>,
/// Whether the email on this account has been verified.
///
/// Requires the `email` oauth scope. See [Discord Docs/User Object].
///
/// [Discord Docs/User Object]: https://discord.com/developers/docs/resources/user#user-object-user-structure
#[serde(skip_serializing_if = "Option::is_none")]
pub verified: Option<bool>,
}
impl CurrentUser {
/// Create a [`Display`] formatter for a user discriminator that pads the
/// discriminator with zeros up to 4 digits.
///
/// [`Display`]: core::fmt::Display
pub const fn discriminator(&self) -> DiscriminatorDisplay {
DiscriminatorDisplay::new(self.discriminator)
}
}
#[cfg(test)]
mod tests {
use super::{CurrentUser, PremiumType, UserFlags};
use crate::{id::Id, test::image_hash};
use serde_test::Token;
fn user_tokens(discriminator_token: Token) -> Vec<Token> {
vec![
Token::Struct {
name: "CurrentUser",
len: 12,
},
Token::Str("accent_color"),
Token::Some,
Token::U32(16_711_680),
Token::Str("avatar"),
Token::Some,
Token::Str(image_hash::AVATAR_INPUT),
Token::Str("banner"),
Token::None,
Token::Str("bot"),
Token::Bool(true),
Token::Str("discriminator"),
discriminator_token,
Token::Str("id"),
Token::NewtypeStruct { name: "Id" },
Token::Str("1"),
Token::Str("locale"),
Token::Some,
Token::Str("test locale"),
Token::Str("mfa_enabled"),
Token::Bool(true),
Token::Str("username"),
Token::Str("test name"),
Token::Str("premium_type"),
Token::Some,
Token::U8(1),
Token::Str("public_flags"),
Token::Some,
Token::U64(1),
Token::Str("verified"),
Token::Some,
Token::Bool(true),
Token::StructEnd,
]
}
fn user_tokens_complete(discriminator_token: Token) -> Vec<Token> {
vec![
Token::Struct {
name: "CurrentUser",
len: 14,
},
Token::Str("accent_color"),
Token::None,
Token::Str("avatar"),
Token::Some,
Token::Str(image_hash::AVATAR_INPUT),
Token::Str("banner"),
Token::Some,
Token::Str(image_hash::BANNER_INPUT),
Token::Str("bot"),
Token::Bool(true),
Token::Str("discriminator"),
discriminator_token,
Token::Str("email"),
Token::Some,
Token::Str("test@example.com"),
Token::Str("flags"),
Token::Some,
Token::U64(1),
Token::Str("id"),
Token::NewtypeStruct { name: "Id" },
Token::Str("1"),
Token::Str("locale"),
Token::Some,
Token::Str("test locale"),
Token::Str("mfa_enabled"),
Token::Bool(true),
Token::Str("username"),
Token::Str("test name"),
Token::Str("premium_type"),
Token::Some,
Token::U8(1),
Token::Str("public_flags"),
Token::Some,
Token::U64(1),
Token::Str("verified"),
Token::Some,
Token::Bool(true),
Token::StructEnd,
]
}
#[test]
fn current_user() {
let value = CurrentUser {
accent_color: Some(16_711_680),
avatar: Some(image_hash::AVATAR),
banner: None,
bot: true,
discriminator: 9999,
email: None,
id: Id::new(1),
mfa_enabled: true,
name: "test name".to_owned(),
verified: Some(true),
premium_type: Some(PremiumType::NitroClassic),
public_flags: Some(UserFlags::STAFF),
flags: None,
locale: Some("test locale".to_owned()),
};
// Deserializing a current user with a string discriminator (which
// Discord provides)
serde_test::assert_tokens(&value, &user_tokens(Token::Str("9999")));
// Deserializing a current user with an integer discriminator. Userland
// code may have this due to being a more compact memory representation
// of a discriminator.
serde_test::assert_de_tokens(&value, &user_tokens(Token::U64(9999)));
}
#[test]
fn current_user_complete() {
let value = CurrentUser {
accent_color: None,
avatar: Some(image_hash::AVATAR),
banner: Some(image_hash::BANNER),
bot: true,
discriminator: 9999,
email: Some("test@example.com".to_owned()),
id: Id::new(1),
mfa_enabled: true,
name: "test name".to_owned(),
verified: Some(true),
premium_type: Some(PremiumType::NitroClassic),
public_flags: Some(UserFlags::STAFF),
flags: Some(UserFlags::STAFF),
locale: Some("test locale".to_owned()),
};
// Deserializing a current user with a string discriminator (which
// Discord provides)
serde_test::assert_tokens(&value, &user_tokens_complete(Token::Str("9999")));
// Deserializing a current user with an integer discriminator. Userland
// code may have this due to being a more compact memory representation
// of a discriminator.
serde_test::assert_de_tokens(&value, &user_tokens_complete(Token::U64(9999)));
}
}