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 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
//! Structures related to Discord guilds. use crate::{ channel::Channel, message::Emoji, presence::Presence, User, voice::VoiceState, }; pub use self::{ member::GuildMember, role::Role, }; mod role; mod audit_log; mod member; /// A Discord Guild, commonly referred to as a "server". #[derive(Deserialize, Debug, Serialize, Clone, Default)] pub struct Guild { /// The snowflake ID of this guild. pub id: String, /// The name of the guild. pub name: String, /// The guild's icon hash. Will be a None value if one is not set. pub icon: Option<String>, /// The guild's splash hash. Will be a None value if it does not exist. pub splash: Option<String>, /// Whether or not the user is an owner of the guild. pub owner: bool, /// The ID of the guild owner. pub owner_id: String, /// The permissions that the user has in this guild. #[serde(default)] pub permissions: i32, /// The region in which this guild is located. pub region: String, /// The AFK channel ID for this guild. pub afk_channel_id: Option<String>, /// The AFK channel timeout for this guild. pub afk_timeout: Option<String>, /// Whether or not the guild can be embedded in a widget. #[serde(default)] pub embed_enabled: bool, /// The channel ID that an embed widget will be generated for. #[serde(default)] pub embed_channel_id: String, /// The amount of members that are currently in this guild. #[serde(default)] pub member_count: i32, /// A list of features that this guild currently has. pub features: Vec<String>, /// A collection of roles that belong to this guild. pub roles: Vec<Role>, /// A collection of emotes that belong to this guild. pub emojis: Vec<Emoji>, /// The explicit content filter level for this guild. pub explicit_content_filter: ExplicitContentFilter, /// The ID of the application which created the guild, if applicable. pub application_id: Option<String>, /// The verification level, which determines which users can chat in a guild. pub verification_level: VerificationLevel, /// The MFA authentication level for this guild. pub mfa_level: MfaLevel, /// The ID of the channel in which system messages are sent to. pub system_channel_id: Option<String>, /// The time that this guild was joined. #[serde(default)] pub joined_at: String, /// Whether this guild is considered a large guild by Discord. #[serde(default)] pub large: bool, /// Whether or not this guild is available. #[serde(default)] pub unavailable: bool, /// Whether or not the server widget is enabled. #[serde(default)] pub widget_enabled: bool, /// The ID of the guild's widget channel, if one exists. #[serde(default)] pub widget_channel_id: String, /// The default message notification setting for this guild. pub default_message_notifications: DefaultMessageNotifications, /// A collection of guild voice states. pub voice_states: Vec<VoiceState>, /// A collection of channels in this guild. #[serde(default)] pub channels: Vec<Channel>, /// A collection of members in this guild. #[serde(default)] pub members: Vec<GuildMember>, /// A collection of presences in this guild. #[serde(default)] pub presences: Vec<Presence> } /// A Partial guild object, usually an offline guild. #[derive(Serialize, Deserialize, Debug, Clone)] pub struct UnavailableGuild { /// The guild ID of the guild. pub id: String, /// Whether or not the guild is available, usually set to true. pub unavailable: bool } /// Represents a packet received when a user is banned from a guild. #[derive(Deserialize, Debug, Clone)] pub struct GuildBanAdd { /// The guild ID of the guild. pub guild_id: String, /// The user who was banned. pub user: User } /// Represents a packet received when a user is unbanned from a guild. #[derive(Deserialize, Debug, Clone)] pub struct GuildBanRemove { /// The guild ID of the guild. pub guild_id: String, /// The user who was unbanned. pub user: User } /// Represents a packet received when a guild's emojis have been updated. #[derive(Deserialize, Debug, Clone)] pub struct GuildEmojisUpdate { /// The guild ID of the guild. pub guild_id: String, /// An array of Emoji objects. pub emojis: Vec<Emoji>, } /// Represents a packet sent when a guild integration is updated. #[derive(Deserialize, Debug, Clone)] pub struct GuildIntegrationsUpdate { /// The guild ID of the guild. pub guild_id: String } /// Represents a packet sent when a user is removed from a guild. #[derive(Deserialize, Debug, Clone)] pub struct GuildMemberRemove { /// The guild ID of the guild. pub guild_id: String, /// The user who was removed. pub user: User } /// Represents a packet sent when a guild member is updated. #[derive(Deserialize, Clone, Debug)] pub struct GuildMemberUpdate { /// The ID of the guild. pub guild_id: String, pub roles: Vec<String>, /// The user who was updated. pub user: User, /// The nickname of the user in the guild. pub nick: String } /// Represents a response to a Guild Request Members packet. #[derive(Deserialize, Debug, Clone)] pub struct GuildMembersChunk { /// The guild ID of the guild. pub guild_id: String, /// An array of guild member objects. pub members: Vec<GuildMember> } /// Represents a packet sent when a role is created ina guild. #[derive(Deserialize, Clone, Debug)] pub struct GuildRoleCreate { /// The guild ID of the guild. pub guild_id: String, /// The newly created role. pub role: Role } /// Represents a packet sent when a role is created in a guild. #[derive(Deserialize, Clone, Debug)] pub struct GuildRoleUpdate { /// The guild ID of the guild. pub guild_id: String, /// The updated role. pub role: Role } /// Represents a packet sent when a role is created in a guild. #[derive(Deserialize, Clone, Debug)] pub struct GuildRoleDelete { /// The guild ID of the guild. pub guild_id: String, /// The ID of the deleted role. pub role: String } /// A guild's explicit content filter levels. #[derive(Deserialize, Debug, Serialize, Clone)] pub enum ExplicitContentFilter { /// The filter is not active. Disabled, /// The filter is only active for members without roles. MembersWithoutRoles, /// The filter is active for all members. AllMembers } impl Default for ExplicitContentFilter { fn default() -> Self { ExplicitContentFilter::Disabled } } /// A guild's MFA levels. #[derive(Deserialize, Debug, Serialize, Clone)] pub enum MfaLevel { /// The guild does not require MFA for elevated actions. None, /// The guild requires MFA on a user account which has elevated permissions. Elevated, } impl Default for MfaLevel { fn default() -> Self { MfaLevel::None } } /// A guild's default message notification setting. #[derive(Deserialize, Debug, Serialize, Clone)] pub enum DefaultMessageNotifications { /// A user will be notified whenever a new message is sent in the guild. AllMessages, /// A user will only be notified when they are mentioned. OnlyMentions } impl Default for DefaultMessageNotifications { fn default() -> Self { DefaultMessageNotifications::AllMessages } } /// A guild's verification levels. #[derive(Deserialize, Debug, Serialize, Clone)] pub enum VerificationLevel { /// The guild is unrestricted. None, /// The guild requires a verified email on the user's account. Low, /// The guild requires that the user be registered on Discord for longer than 5 minutes. Medium, /// The guild requires that the user be on the guild for longer than 10 minutes. High, /// The guild requires that the user have a verified phone number on their account. Insane } impl Default for VerificationLevel { fn default() -> Self { VerificationLevel::None } }