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
//! Gateway event payload when an invite is created.
use crate::{
guild::invite::TargetType,
id::{
marker::{ChannelMarker, GuildMarker, UserMarker},
Id,
},
user::{self, DiscriminatorDisplay, User},
util::{ImageHash, Timestamp},
};
use serde::{Deserialize, Serialize};
/// A new [`Invite`] has been created.
///
/// [`Invite`]: crate::guild::invite::Invite
#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
pub struct InviteCreate {
/// ID of the channel invited users will first see.
pub channel_id: Id<ChannelMarker>,
/// Unique code.
pub code: String,
/// When the invite was created.
pub created_at: Timestamp,
/// ID of the guild being invited to.
pub guild_id: Id<GuildMarker>,
/// Information about the user who created the invite.
#[serde(skip_serializing_if = "Option::is_none")]
pub inviter: Option<User>,
/// Maximum age before the invite expires.
///
/// This is in seconds.
pub max_age: u64,
/// Maximum number of uses before the invite expires.
pub max_uses: u64,
/// Target of the invite.
#[serde(skip_serializing_if = "Option::is_none")]
pub target_user_type: Option<TargetType>,
/// User whose stream to display for this voice channel stream invite.
#[serde(skip_serializing_if = "Option::is_none")]
pub target_user: Option<PartialUser>,
/// Whether the invite is temporary.
///
/// Invited users will be kicked when they are disconnected from an audio
/// channel unless they're assigned a role.
pub temporary: bool,
/// Number of times the invite has been used.
///
/// This will always be zero.
pub uses: u8,
}
/// Information about the user whose stream to display for a voice channel
/// stream invite.
#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
pub struct PartialUser {
/// Hash of the user's avatar.
pub avatar: Option<ImageHash>,
/// Discriminator used to differentiate people with the same [`username`].
///
/// [`username`]: Self::username
///
/// # 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.
#[serde(with = "user::discriminator")]
pub discriminator: u16,
/// ID of the user.
pub id: Id<UserMarker>,
/// Username of the user.
pub username: String,
}
impl PartialUser {
/// Create a [`Display`] formatter for a user discriminator.
///
/// [`Display`]: core::fmt::Display
pub const fn discriminator(&self) -> DiscriminatorDisplay {
DiscriminatorDisplay::new(self.discriminator)
}
}
#[cfg(test)]
mod tests {
use super::{InviteCreate, PartialUser};
use crate::{id::Id, test::image_hash, util::Timestamp};
use serde::{Deserialize, Serialize};
use serde_test::Token;
use static_assertions::{assert_fields, assert_impl_all};
use std::{fmt::Debug, hash::Hash};
assert_fields!(
InviteCreate: channel_id,
code,
created_at,
guild_id,
inviter,
max_age,
max_uses,
target_user_type,
target_user,
temporary,
uses
);
assert_fields!(PartialUser: avatar, discriminator, id, username);
assert_impl_all!(
InviteCreate: Clone,
Debug,
Deserialize<'static>,
Eq,
Hash,
PartialEq,
Send,
Serialize,
Sync
);
assert_impl_all!(
PartialUser: Clone,
Debug,
Deserialize<'static>,
Eq,
Hash,
PartialEq,
Send,
Serialize,
Sync
);
#[test]
fn invite_create() {
let created_at = Timestamp::from_secs(1_609_459_200).expect("non zero");
let value = InviteCreate {
channel_id: Id::new(1),
code: "a".repeat(7),
created_at,
guild_id: Id::new(2),
inviter: None,
max_age: 3600,
max_uses: 5,
target_user_type: None,
target_user: None,
temporary: false,
uses: 0,
};
serde_test::assert_tokens(
&value,
&[
Token::Struct {
name: "InviteCreate",
len: 8,
},
Token::Str("channel_id"),
Token::NewtypeStruct { name: "Id" },
Token::Str("1"),
Token::Str("code"),
Token::Str("aaaaaaa"),
Token::Str("created_at"),
Token::Str("2021-01-01T00:00:00.000000+00:00"),
Token::Str("guild_id"),
Token::NewtypeStruct { name: "Id" },
Token::Str("2"),
Token::Str("max_age"),
Token::U64(3600),
Token::Str("max_uses"),
Token::U64(5),
Token::Str("temporary"),
Token::Bool(false),
Token::Str("uses"),
Token::U8(0),
Token::StructEnd,
],
);
}
#[test]
fn partial_user() {
let value = PartialUser {
avatar: Some(image_hash::AVATAR),
discriminator: 123,
id: Id::new(1),
username: "twilight".to_owned(),
};
serde_test::assert_tokens(
&value,
&[
Token::Struct {
name: "PartialUser",
len: 4,
},
Token::Str("avatar"),
Token::Some,
Token::Str(image_hash::AVATAR_INPUT),
Token::Str("discriminator"),
Token::Str("0123"),
Token::Str("id"),
Token::NewtypeStruct { name: "Id" },
Token::Str("1"),
Token::Str("username"),
Token::Str("twilight"),
Token::StructEnd,
],
);
}
}