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 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
//! All the events this library handles.
//!
//! Every event includes the gateway intent required to receive it, as well as a link to the
//! Discord documentation for the event.
// Just for MessageUpdateEvent (for some reason the #[allow] doesn't work when placed directly)
#![allow(clippy::option_option)]
use serde::de::Error as DeError;
use serde::Serialize;
use crate::constants::Opcode;
use crate::model::prelude::*;
use crate::model::utils::{
deserialize_val,
emojis,
members,
remove_from_map,
remove_from_map_opt,
stickers,
};
/// Requires no gateway intents.
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#application-command-permissions-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct CommandPermissionsUpdateEvent {
pub permission: CommandPermissions,
}
/// Requires [`GatewayIntents::AUTO_MODERATION_CONFIGURATION`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct AutoModRuleCreateEvent {
pub rule: Rule,
}
/// Requires [`GatewayIntents::AUTO_MODERATION_CONFIGURATION`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct AutoModRuleUpdateEvent {
pub rule: Rule,
}
/// Requires [`GatewayIntents::AUTO_MODERATION_CONFIGURATION`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct AutoModRuleDeleteEvent {
pub rule: Rule,
}
/// Requires [`GatewayIntents::AUTO_MODERATION_EXECUTION`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#auto-moderation-action-execution).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct AutoModActionExecutionEvent {
pub execution: ActionExecution,
}
/// Event data for the channel creation event.
///
/// This is fired when:
/// - A [`Channel`] is created in a [`Guild`]
///
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#channel-create).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct ChannelCreateEvent {
/// The channel that was created.
pub channel: GuildChannel,
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#channel-delete).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct ChannelDeleteEvent {
pub channel: GuildChannel,
}
/// Requires [`GatewayIntents::GUILDS`] or [`GatewayIntents::DIRECT_MESSAGES`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#channel-pins-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct ChannelPinsUpdateEvent {
pub guild_id: Option<GuildId>,
pub channel_id: ChannelId,
pub last_pin_timestamp: Option<Timestamp>,
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#channel-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct ChannelUpdateEvent {
pub channel: GuildChannel,
}
/// Requires [`GatewayIntents::GUILD_MODERATION`] and [`Permissions::VIEW_AUDIT_LOG`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-audit-log-entry-create).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct GuildAuditLogEntryCreateEvent {
pub guild_id: GuildId,
#[serde(flatten)]
pub entry: AuditLogEntry,
}
/// Requires [`GatewayIntents::GUILD_MODERATION`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-ban-add).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct GuildBanAddEvent {
pub guild_id: GuildId,
pub user: User,
}
/// Requires [`GatewayIntents::GUILD_MODERATION`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct GuildBanRemoveEvent {
pub guild_id: GuildId,
pub user: User,
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-create).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct GuildCreateEvent {
pub guild: Guild,
}
// Manual impl needed to insert guild_id fields in GuildChannel, Member, Role
impl<'de> Deserialize<'de> for GuildCreateEvent {
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> StdResult<Self, D::Error> {
let mut guild: Guild = Guild::deserialize(deserializer)?;
guild.channels.values_mut().for_each(|x| x.guild_id = guild.id);
guild.members.values_mut().for_each(|x| x.guild_id = guild.id);
guild.roles.values_mut().for_each(|x| x.guild_id = guild.id);
Ok(Self {
guild,
})
}
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-delete).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct GuildDeleteEvent {
pub guild: UnavailableGuild,
}
/// Requires [`GatewayIntents::GUILD_EMOJIS_AND_STICKERS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-emojis-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct GuildEmojisUpdateEvent {
#[serde(with = "emojis")]
pub emojis: HashMap<EmojiId, Emoji>,
pub guild_id: GuildId,
}
/// Requires [`GatewayIntents::GUILD_INTEGRATIONS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-integrations-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct GuildIntegrationsUpdateEvent {
pub guild_id: GuildId,
}
/// Requires [`GatewayIntents::GUILD_MEMBERS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-member-add).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct GuildMemberAddEvent {
pub member: Member,
}
/// Requires [`GatewayIntents::GUILD_MEMBERS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-member-remove).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct GuildMemberRemoveEvent {
pub guild_id: GuildId,
pub user: User,
}
/// Requires [`GatewayIntents::GUILD_MEMBERS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-member-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct GuildMemberUpdateEvent {
pub guild_id: GuildId,
pub nick: Option<String>,
pub joined_at: Timestamp,
pub roles: Vec<RoleId>,
pub user: User,
pub premium_since: Option<Timestamp>,
#[serde(default)]
pub pending: bool,
#[serde(default)]
pub deaf: bool,
#[serde(default)]
pub mute: bool,
pub avatar: Option<ImageHash>,
pub communication_disabled_until: Option<Timestamp>,
pub unusual_dm_activity_until: Option<Timestamp>,
}
/// Requires no gateway intents.
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(remote = "Self")]
#[non_exhaustive]
pub struct GuildMembersChunkEvent {
/// ID of the guild.
pub guild_id: GuildId,
/// Set of guild members.
#[serde(with = "members")]
pub members: HashMap<UserId, Member>,
/// Chunk index in the expected chunks for this response (0 <= chunk_index < chunk_count).
pub chunk_index: u32,
/// Total number of expected chunks for this response.
pub chunk_count: u32,
/// When passing an invalid ID to [`crate::gateway::ShardRunnerMessage::ChunkGuild`], it will
/// be returned here.
#[serde(default)]
pub not_found: Vec<GenericId>,
/// When passing true to [`crate::gateway::ShardRunnerMessage::ChunkGuild`], presences of the
/// returned members will be here.
pub presences: Option<Vec<Presence>>,
/// Nonce used in the [`crate::gateway::ShardRunnerMessage::ChunkGuild`] request.
pub nonce: Option<String>,
}
// Manual impl needed to insert guild_id fields in Member
impl<'de> Deserialize<'de> for GuildMembersChunkEvent {
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> StdResult<Self, D::Error> {
let mut event = Self::deserialize(deserializer)?; // calls #[serde(remote)]-generated inherent method
event.members.values_mut().for_each(|m| m.guild_id = event.guild_id);
Ok(event)
}
}
impl Serialize for GuildMembersChunkEvent {
fn serialize<S: serde::Serializer>(&self, serializer: S) -> StdResult<S::Ok, S::Error> {
Self::serialize(self, serializer) // calls #[serde(remote)]-generated inherent method
}
}
/// Helper to deserialize `GuildRoleCreateEvent` and `GuildRoleUpdateEvent`.
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Deserialize)]
struct RoleEventHelper {
guild_id: GuildId,
role: Role,
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-role-create).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Serialize)]
#[non_exhaustive]
pub struct GuildRoleCreateEvent {
pub role: Role,
}
// Manual impl needed to insert guild_id field in Role
impl<'de> Deserialize<'de> for GuildRoleCreateEvent {
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> StdResult<Self, D::Error> {
let mut event = RoleEventHelper::deserialize(deserializer)?;
event.role.guild_id = event.guild_id;
Ok(Self {
role: event.role,
})
}
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-role-delete).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct GuildRoleDeleteEvent {
pub guild_id: GuildId,
pub role_id: RoleId,
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-role-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Serialize)]
#[non_exhaustive]
pub struct GuildRoleUpdateEvent {
pub role: Role,
}
// Manual impl needed to insert guild_id field in Role
impl<'de> Deserialize<'de> for GuildRoleUpdateEvent {
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> StdResult<Self, D::Error> {
let mut event = RoleEventHelper::deserialize(deserializer)?;
event.role.guild_id = event.guild_id;
Ok(Self {
role: event.role,
})
}
}
/// Requires [`GatewayIntents::GUILD_EMOJIS_AND_STICKERS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-stickers-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct GuildStickersUpdateEvent {
#[serde(with = "stickers")]
pub stickers: HashMap<StickerId, Sticker>,
pub guild_id: GuildId,
}
/// Requires [`GatewayIntents::GUILD_INVITES`] and [`Permissions::MANAGE_CHANNELS´] permission.
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#invite-create).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct InviteCreateEvent {
/// Whether or not the invite is temporary (invited users will be kicked on disconnect unless
/// Channel the invite is for.
pub channel_id: ChannelId,
/// Unique invite [code](Invite::code).
pub code: String,
/// Time at which the invite was created.
pub created_at: Timestamp,
/// Guild of the invite.
pub guild_id: Option<GuildId>,
/// User that created the invite.
pub inviter: Option<User>,
/// How long the invite is valid for (in seconds).
pub max_age: u32,
/// Maximum number of times the invite can be used.
pub max_uses: u8,
/// Type of target for this voice channel invite.
pub target_type: Option<InviteTargetType>,
/// User whose stream to display for this voice channel stream invite.
pub target_user: Option<User>,
/// Embedded application to open for this voice channel embedded application invite.
pub target_application: Option<Value>,
/// they're assigned a role).
pub temporary: bool,
/// How many times the invite has been used (always will be 0).
pub uses: u64,
}
/// Requires [`GatewayIntents::GUILD_INVITES`] and [`Permissions::MANAGE_CHANNELS´] permission.
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#invite-delete).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct InviteDeleteEvent {
pub channel_id: ChannelId,
pub guild_id: Option<GuildId>,
pub code: String,
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct GuildUpdateEvent {
/// GuildUpdateEvent doesn't have GuildCreate's extra fields, so this is a partial guild
pub guild: PartialGuild,
}
/// Requires [`GatewayIntents::GUILD_MESSAGES`] or [`GatewayIntents::DIRECT_MESSAGES`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#message-create).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct MessageCreateEvent {
pub message: Message,
}
/// Requires [`GatewayIntents::GUILD_MESSAGES`] or [`GatewayIntents::DIRECT_MESSAGES`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#message-delete-bulk).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct MessageDeleteBulkEvent {
pub guild_id: Option<GuildId>,
pub channel_id: ChannelId,
pub ids: Vec<MessageId>,
}
/// Requires [`GatewayIntents::GUILD_MESSAGES`] or [`GatewayIntents::DIRECT_MESSAGES`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#message-delete).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct MessageDeleteEvent {
pub guild_id: Option<GuildId>,
pub channel_id: ChannelId,
#[serde(rename = "id")]
pub message_id: MessageId,
}
// Any value that is present is considered Some value, including null.
// Taken from https://github.com/serde-rs/serde/issues/984#issuecomment-314143738
fn deserialize_some<'de, T, D>(deserializer: D) -> Result<Option<T>, D::Error>
where
T: Deserialize<'de>,
D: Deserializer<'de>,
{
Deserialize::deserialize(deserializer).map(Some)
}
/// Requires [`GatewayIntents::GUILD_MESSAGES`].
///
/// Contains identical fields to [`Message`], except everything but `id` and `channel_id` are
/// optional. Even fields that cannot change in a message update event are included, because Discord
/// may include them anyways, independent from whether they have actually changed (like
/// [`Self::guild_id`])
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#message-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct MessageUpdateEvent {
pub id: MessageId,
pub channel_id: ChannelId,
pub author: Option<User>,
pub content: Option<String>,
pub timestamp: Option<Timestamp>,
pub edited_timestamp: Option<Timestamp>,
pub tts: Option<bool>,
pub mention_everyone: Option<bool>,
pub mentions: Option<Vec<User>>,
pub mention_roles: Option<Vec<RoleId>>,
pub mention_channels: Option<Vec<ChannelMention>>,
pub attachments: Option<Vec<Attachment>>,
pub embeds: Option<Vec<Embed>>,
pub reactions: Option<Vec<MessageReaction>>,
pub pinned: Option<bool>,
#[serde(default, deserialize_with = "deserialize_some")]
pub webhook_id: Option<Option<WebhookId>>,
#[serde(rename = "type")]
pub kind: Option<MessageType>,
#[serde(default, deserialize_with = "deserialize_some")]
pub activity: Option<Option<MessageActivity>>,
#[serde(default, deserialize_with = "deserialize_some")]
pub application: Option<Option<MessageApplication>>,
#[serde(default, deserialize_with = "deserialize_some")]
pub application_id: Option<Option<ApplicationId>>,
pub message_reference: Option<Option<MessageReference>>,
#[serde(default, deserialize_with = "deserialize_some")]
pub flags: Option<Option<MessageFlags>>,
#[serde(default, deserialize_with = "deserialize_some")]
pub referenced_message: Option<Option<Box<Message>>>,
#[serde(default, deserialize_with = "deserialize_some")]
pub interaction: Option<Option<Box<MessageInteraction>>>,
#[serde(default, deserialize_with = "deserialize_some")]
pub thread: Option<Option<GuildChannel>>,
pub components: Option<Vec<ActionRow>>,
pub sticker_items: Option<Vec<StickerItem>>,
pub position: Option<Option<u64>>,
pub role_subscription_data: Option<Option<RoleSubscriptionData>>,
pub guild_id: Option<GuildId>,
pub member: Option<Option<Box<PartialMember>>>,
}
impl MessageUpdateEvent {
#[allow(clippy::clone_on_copy)] // For consistency between fields
#[rustfmt::skip]
/// Writes the updated data in this message update event into the given [`Message`].
pub fn apply_to_message(&self, message: &mut Message) {
// Destructure, so we get an `unused` warning when we forget to process one of the fields
// in this method
#[allow(deprecated)] // yes rust, exhaustive means exhaustive, even the deprecated ones
let Self {
id,
channel_id,
author,
content,
timestamp,
edited_timestamp,
tts,
mention_everyone,
mentions,
mention_roles,
mention_channels,
attachments,
embeds,
reactions,
pinned,
webhook_id,
kind,
activity,
application,
application_id,
message_reference,
flags,
referenced_message,
interaction,
thread,
components,
sticker_items,
position,
role_subscription_data,
guild_id,
member,
} = self;
// Discord won't send a MessageUpdateEvent with a different MessageId and ChannelId than we
// already have. But let's set the fields anyways, in case the user calls this method with
// a self-constructed MessageUpdateEvent that does change these fields.
message.id = *id;
message.channel_id = *channel_id;
if let Some(x) = author { message.author = x.clone() }
if let Some(x) = content { message.content = x.clone() }
if let Some(x) = timestamp { message.timestamp = x.clone() }
message.edited_timestamp = *edited_timestamp;
if let Some(x) = tts { message.tts = x.clone() }
if let Some(x) = mention_everyone { message.mention_everyone = x.clone() }
if let Some(x) = mentions { message.mentions = x.clone() }
if let Some(x) = mention_roles { message.mention_roles = x.clone() }
if let Some(x) = mention_channels { message.mention_channels = x.clone() }
if let Some(x) = attachments { message.attachments = x.clone() }
if let Some(x) = embeds { message.embeds = x.clone() }
if let Some(x) = reactions { message.reactions = x.clone() }
if let Some(x) = pinned { message.pinned = x.clone() }
if let Some(x) = webhook_id { message.webhook_id = x.clone() }
if let Some(x) = kind { message.kind = x.clone() }
if let Some(x) = activity { message.activity = x.clone() }
if let Some(x) = application { message.application = x.clone() }
if let Some(x) = application_id { message.application_id = x.clone() }
if let Some(x) = message_reference { message.message_reference = x.clone() }
if let Some(x) = flags { message.flags = x.clone() }
if let Some(x) = referenced_message { message.referenced_message = x.clone() }
if let Some(x) = interaction { message.interaction = x.clone() }
if let Some(x) = thread { message.thread = x.clone() }
if let Some(x) = components { message.components = x.clone() }
if let Some(x) = sticker_items { message.sticker_items = x.clone() }
if let Some(x) = position { message.position = x.clone() }
if let Some(x) = role_subscription_data { message.role_subscription_data = x.clone() }
message.guild_id = *guild_id;
if let Some(x) = member { message.member = x.clone() }
}
}
/// Requires [`GatewayIntents::GUILD_PRESENCES`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#presence-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct PresenceUpdateEvent {
pub presence: Presence,
}
/// Not officially documented.
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct PresencesReplaceEvent {
pub presences: Vec<Presence>,
}
/// Requires [`GatewayIntents::GUILD_MESSAGE_REACTIONS`] or
/// [`GatewayIntents::DIRECT_MESSAGE_REACTIONS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#message-reaction-add).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct ReactionAddEvent {
pub reaction: Reaction,
}
/// Requires [`GatewayIntents::GUILD_MESSAGE_REACTIONS`] or
/// [`GatewayIntents::DIRECT_MESSAGE_REACTIONS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct ReactionRemoveEvent {
// The Discord API doesn't share the same schema for Reaction Remove Event and Reaction Add
// Event (which [`Reaction`] is), but the two currently match up well enough, so re-using the
// [`Reaction`] struct here is fine.
pub reaction: Reaction,
}
/// Requires [`GatewayIntents::GUILD_MESSAGE_REACTIONS`] or
/// [`GatewayIntents::DIRECT_MESSAGE_REACTIONS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct ReactionRemoveAllEvent {
pub channel_id: ChannelId,
pub message_id: MessageId,
pub guild_id: Option<GuildId>,
}
/// Requires [`GatewayIntents::GUILD_MESSAGE_REACTIONS`] or
/// [`GatewayIntents::DIRECT_MESSAGE_REACTIONS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-emoji-message-reaction-remove-emoji-event-fields).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct ReactionRemoveEmojiEvent {
pub reaction: Reaction,
}
/// The "Ready" event, containing initial ready cache
///
/// Requires no gateway intents.
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#ready).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct ReadyEvent {
pub ready: Ready,
}
/// Requires no gateway intents.
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#resumed).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct ResumedEvent {}
/// Requires [`GatewayIntents::GUILD_MESSAGE_TYPING`] or [`GatewayIntents::DIRECT_MESSAGE_TYPING`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#typing-start).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct TypingStartEvent {
/// ID of the channel.
pub channel_id: ChannelId,
/// ID of the guild.
pub guild_id: Option<GuildId>,
/// ID of the user.
pub user_id: UserId,
/// Timestamp of when the user started typing.
pub timestamp: u64,
/// Member who started typing if this happened in a guild.
pub member: Option<Member>,
}
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct UnknownEvent {
#[serde(rename = "t")]
pub kind: String,
#[serde(rename = "d")]
pub value: Value,
}
/// Sent when properties about the current bot's user change.
///
/// Requires no gateway intents.
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#user-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct UserUpdateEvent {
pub current_user: CurrentUser,
}
/// Requires no gateway intents.
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#voice-server-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct VoiceServerUpdateEvent {
pub token: String,
pub guild_id: Option<GuildId>,
pub endpoint: Option<String>,
}
/// Requires [`GatewayIntents::GUILD_VOICE_STATES`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#voice-state-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct VoiceStateUpdateEvent {
pub voice_state: VoiceState,
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Incomplete documentation](https://github.com/discord/discord-api-docs/pull/6398)
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct VoiceChannelStatusUpdateEvent {
pub status: Option<String>,
pub id: ChannelId,
pub guild_id: GuildId,
}
/// Requires [`GatewayIntents::GUILD_WEBHOOKS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#webhooks-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct WebhookUpdateEvent {
pub channel_id: ChannelId,
pub guild_id: GuildId,
}
/// Requires no gateway intents.
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#interaction-create).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct InteractionCreateEvent {
pub interaction: Interaction,
}
/// Requires [`GatewayIntents::GUILD_INTEGRATIONS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#integration-create).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct IntegrationCreateEvent {
pub integration: Integration,
}
/// Requires [`GatewayIntents::GUILD_INTEGRATIONS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#integration-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct IntegrationUpdateEvent {
pub integration: Integration,
}
/// Requires [`GatewayIntents::GUILD_INTEGRATIONS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#integration-delete).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Serialize, Deserialize)]
#[non_exhaustive]
pub struct IntegrationDeleteEvent {
pub id: IntegrationId,
pub guild_id: GuildId,
pub application_id: Option<ApplicationId>,
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#stage-instance-create).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct StageInstanceCreateEvent {
pub stage_instance: StageInstance,
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#stage-instance-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct StageInstanceUpdateEvent {
pub stage_instance: StageInstance,
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#stage-instance-delete).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct StageInstanceDeleteEvent {
pub stage_instance: StageInstance,
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#thread-create).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct ThreadCreateEvent {
pub thread: GuildChannel,
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#thread-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct ThreadUpdateEvent {
pub thread: GuildChannel,
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#thread-delete).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct ThreadDeleteEvent {
pub thread: PartialGuildChannel,
}
/// Requires [`GatewayIntents::GUILDS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#thread-list-sync).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct ThreadListSyncEvent {
/// The guild Id.
pub guild_id: GuildId,
/// The parent channel Id whose threads are being synced. If omitted, then threads were synced
/// for the entire guild. This array may contain channel Ids that have no active threads as
/// well, so you know to clear that data.
pub channel_ids: Option<Vec<ChannelId>>,
/// All active threads in the given channels that the current user can access.
pub threads: Vec<GuildChannel>,
/// All thread member objects from the synced threads for the current user, indicating which
/// threads the current user has been added to
pub members: Vec<ThreadMember>,
}
/// Requires [`GatewayIntents::GUILDS`], and, to receive this event for other users,
/// [`GatewayIntents::GUILD_MEMBERS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#thread-member-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct ThreadMemberUpdateEvent {
pub member: ThreadMember,
}
/// Requires [`GatewayIntents::GUILD_MEMBERS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#thread-members-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct ThreadMembersUpdateEvent {
/// The id of the thread.
pub id: ChannelId,
/// The id of the Guild.
pub guild_id: GuildId,
/// The approximate number of members in the thread, capped at 50.
///
/// NOTE: This count has been observed to be above 50, or below 0.
/// See: <https://github.com/discord/discord-api-docs/issues/5139>
pub member_count: i16,
/// The users who were added to the thread.
#[serde(default)]
pub added_members: Vec<ThreadMember>,
/// The ids of the users who were removed from the thread.
#[serde(default)]
pub removed_member_ids: Vec<UserId>,
}
/// Requires [`GatewayIntents::GUILD_SCHEDULED_EVENTS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-create).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct GuildScheduledEventCreateEvent {
pub event: ScheduledEvent,
}
/// Requires [`GatewayIntents::GUILD_SCHEDULED_EVENTS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-update).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct GuildScheduledEventUpdateEvent {
pub event: ScheduledEvent,
}
/// Requires [`GatewayIntents::GUILD_SCHEDULED_EVENTS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-delete).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct GuildScheduledEventDeleteEvent {
pub event: ScheduledEvent,
}
/// Requires [`GatewayIntents::GUILD_SCHEDULED_EVENTS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-add).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct GuildScheduledEventUserAddEvent {
#[serde(rename = "guild_scheduled_event_id")]
pub scheduled_event_id: ScheduledEventId,
pub user_id: UserId,
pub guild_id: GuildId,
}
/// Requires [`GatewayIntents::GUILD_SCHEDULED_EVENTS`].
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-remove).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct GuildScheduledEventUserRemoveEvent {
#[serde(rename = "guild_scheduled_event_id")]
pub scheduled_event_id: ScheduledEventId,
pub user_id: UserId,
pub guild_id: GuildId,
}
/// Requires no gateway intents.
///
/// [Discord docs](https://discord.com/developers/docs/monetization/entitlements#new-entitlement)
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct EntitlementCreateEvent {
pub entitlement: Entitlement,
}
/// Requires no gateway intents.
///
/// [Discord docs](https://discord.com/developers/docs/monetization/entitlements#new-entitlement)
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct EntitlementUpdateEvent {
pub entitlement: Entitlement,
}
/// Requires no gateway intents.
///
/// [Discord docs](https://discord.com/developers/docs/monetization/entitlements#new-entitlement)
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(transparent)]
#[non_exhaustive]
pub struct EntitlementDeleteEvent {
pub entitlement: Entitlement,
}
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#payload-structure).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[allow(clippy::large_enum_variant)]
#[derive(Debug, Clone, Serialize)]
#[non_exhaustive]
#[serde(untagged)]
pub enum GatewayEvent {
Dispatch(u64, Event),
Heartbeat(u64),
Reconnect,
/// Whether the session can be resumed.
InvalidateSession(bool),
Hello(u64),
HeartbeatAck,
}
// Manual impl needed to emulate integer enum tags
impl<'de> Deserialize<'de> for GatewayEvent {
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> StdResult<Self, D::Error> {
let mut map = JsonMap::deserialize(deserializer)?;
let seq = remove_from_map_opt(&mut map, "s")?.flatten();
Ok(match remove_from_map(&mut map, "op")? {
Opcode::Dispatch => Self::Dispatch(
seq.ok_or_else(|| DeError::missing_field("s"))?,
deserialize_val(Value::from(map))?,
),
Opcode::Heartbeat => {
GatewayEvent::Heartbeat(seq.ok_or_else(|| DeError::missing_field("s"))?)
},
Opcode::InvalidSession => {
GatewayEvent::InvalidateSession(remove_from_map(&mut map, "d")?)
},
Opcode::Hello => {
#[derive(Deserialize)]
struct HelloPayload {
heartbeat_interval: u64,
}
let inner: HelloPayload = remove_from_map(&mut map, "d")?;
GatewayEvent::Hello(inner.heartbeat_interval)
},
Opcode::Reconnect => GatewayEvent::Reconnect,
Opcode::HeartbeatAck => GatewayEvent::HeartbeatAck,
_ => return Err(DeError::custom("invalid opcode")),
})
}
}
/// Event received over a websocket connection
///
/// [Discord docs](https://discord.com/developers/docs/topics/gateway-events#receive-events).
#[allow(clippy::large_enum_variant)]
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
#[serde(tag = "t", content = "d")]
#[non_exhaustive]
pub enum Event {
/// The permissions of an [`Command`] was changed.
///
/// Fires the [`EventHandler::command_permissions_update`] event.
///
/// [`Command`]: crate::model::application::Command
/// [`EventHandler::command_permissions_update`]: crate::client::EventHandler::command_permissions_update
CommandPermissionsUpdate(CommandPermissionsUpdateEvent),
/// A [`Rule`] was created.
///
/// Fires the [`EventHandler::auto_moderation_rule_create`] event.
///
/// [`EventHandler::auto_moderation_rule_create`]:
/// crate::client::EventHandler::auto_moderation_rule_create
AutoModRuleCreate(AutoModRuleCreateEvent),
/// A [`Rule`] has been updated.
///
/// Fires the [`EventHandler::auto_moderation_rule_update`] event.
///
/// [`EventHandler::auto_moderation_rule_update`]:
/// crate::client::EventHandler::auto_moderation_rule_update
AutoModRuleUpdate(AutoModRuleUpdateEvent),
/// A [`Rule`] was deleted.
///
/// Fires the [`EventHandler::auto_moderation_rule_delete`] event.
///
/// [`EventHandler::auto_moderation_rule_delete`]:
/// crate::client::EventHandler::auto_moderation_rule_delete
AutoModRuleDelete(AutoModRuleDeleteEvent),
/// A [`Rule`] was triggered and an action was executed.
///
/// Fires the [`EventHandler::auto_moderation_action_execution`] event.
///
/// [`EventHandler::auto_moderation_action_execution`]:
/// crate::client::EventHandler::auto_moderation_action_execution
#[serde(rename = "AUTO_MODERATION_ACTION_EXECUTION")]
AutoModActionExecution(AutoModActionExecutionEvent),
/// A [`Channel`] was created.
///
/// Fires the [`EventHandler::channel_create`] event.
///
/// [`EventHandler::channel_create`]: crate::client::EventHandler::channel_create
ChannelCreate(ChannelCreateEvent),
/// A [`Channel`] has been deleted.
///
/// Fires the [`EventHandler::channel_delete`] event.
///
/// [`EventHandler::channel_delete`]: crate::client::EventHandler::channel_delete
ChannelDelete(ChannelDeleteEvent),
/// The pins for a [`Channel`] have been updated.
///
/// Fires the [`EventHandler::channel_pins_update`] event.
///
/// [`EventHandler::channel_pins_update`]: crate::client::EventHandler::channel_pins_update
ChannelPinsUpdate(ChannelPinsUpdateEvent),
/// A [`Channel`] has been updated.
///
/// Fires the [`EventHandler::channel_update`] event.
///
/// [`EventHandler::channel_update`]: crate::client::EventHandler::channel_update
ChannelUpdate(ChannelUpdateEvent),
GuildAuditLogEntryCreate(GuildAuditLogEntryCreateEvent),
GuildBanAdd(GuildBanAddEvent),
GuildBanRemove(GuildBanRemoveEvent),
GuildCreate(GuildCreateEvent),
GuildDelete(GuildDeleteEvent),
GuildEmojisUpdate(GuildEmojisUpdateEvent),
GuildIntegrationsUpdate(GuildIntegrationsUpdateEvent),
GuildMemberAdd(GuildMemberAddEvent),
GuildMemberRemove(GuildMemberRemoveEvent),
/// A member's roles have changed
GuildMemberUpdate(GuildMemberUpdateEvent),
GuildMembersChunk(GuildMembersChunkEvent),
GuildRoleCreate(GuildRoleCreateEvent),
GuildRoleDelete(GuildRoleDeleteEvent),
GuildRoleUpdate(GuildRoleUpdateEvent),
/// A [`Sticker`] was created, updated, or deleted
GuildStickersUpdate(GuildStickersUpdateEvent),
GuildUpdate(GuildUpdateEvent),
/// An [`Invite`] was created.
///
/// Fires the [`EventHandler::invite_create`] event handler.
///
/// [`EventHandler::invite_create`]: crate::client::EventHandler::invite_create
InviteCreate(InviteCreateEvent),
/// An [`Invite`] was deleted.
///
/// Fires the [`EventHandler::invite_delete`] event handler.
///
/// [`EventHandler::invite_delete`]: crate::client::EventHandler::invite_delete
InviteDelete(InviteDeleteEvent),
MessageCreate(MessageCreateEvent),
MessageDelete(MessageDeleteEvent),
MessageDeleteBulk(MessageDeleteBulkEvent),
/// A message has been edited, either by the user or the system
MessageUpdate(MessageUpdateEvent),
/// A member's presence state (or username or avatar) has changed
PresenceUpdate(PresenceUpdateEvent),
/// The presence list of the user's friends should be replaced entirely
PresencesReplace(PresencesReplaceEvent),
/// A reaction was added to a message.
///
/// Fires the [`EventHandler::reaction_add`] event handler.
///
/// [`EventHandler::reaction_add`]: crate::client::EventHandler::reaction_add
#[serde(rename = "MESSAGE_REACTION_ADD")]
ReactionAdd(ReactionAddEvent),
/// A reaction was removed to a message.
///
/// Fires the [`EventHandler::reaction_remove`] event handler.
///
/// [`EventHandler::reaction_remove`]: crate::client::EventHandler::reaction_remove
#[serde(rename = "MESSAGE_REACTION_REMOVE")]
ReactionRemove(ReactionRemoveEvent),
/// A request was issued to remove all [`Reaction`]s from a [`Message`].
///
/// Fires the [`EventHandler::reaction_remove_all`] event handler.
///
/// [`EventHandler::reaction_remove_all`]: crate::client::EventHandler::reaction_remove_all
#[serde(rename = "MESSAGE_REACTION_REMOVE_ALL")]
ReactionRemoveAll(ReactionRemoveAllEvent),
/// Sent when a bot removes all instances of a given emoji from the reactions of a message.
///
/// Fires the [`EventHandler::reaction_remove_emoji`] event handler.
///
/// [`EventHandler::reaction_remove_emoji`]: crate::client::EventHandler::reaction_remove_emoji
#[serde(rename = "MESSAGE_REACTION_REMOVE_EMOJI")]
ReactionRemoveEmoji(ReactionRemoveEmojiEvent),
/// The first event in a connection, containing the initial ready cache.
///
/// May also be received at a later time in the event of a reconnect.
Ready(ReadyEvent),
/// The connection has successfully resumed after a disconnect.
Resumed(ResumedEvent),
/// A user is typing; considered to last 5 seconds
TypingStart(TypingStartEvent),
/// Update to the logged-in user's information
UserUpdate(UserUpdateEvent),
/// A member's voice state has changed
VoiceStateUpdate(VoiceStateUpdateEvent),
/// Voice server information is available
VoiceServerUpdate(VoiceServerUpdateEvent),
/// Fired when the status of a Voice Channel changes.
VoiceChannelStatusUpdate(VoiceChannelStatusUpdateEvent),
/// A webhook for a [channel][`GuildChannel`] was updated in a [`Guild`].
WebhookUpdate(WebhookUpdateEvent),
/// An interaction was created.
InteractionCreate(InteractionCreateEvent),
/// A guild integration was created
IntegrationCreate(IntegrationCreateEvent),
/// A guild integration was updated
IntegrationUpdate(IntegrationUpdateEvent),
/// A guild integration was deleted
IntegrationDelete(IntegrationDeleteEvent),
/// A stage instance was created.
StageInstanceCreate(StageInstanceCreateEvent),
/// A stage instance was updated.
StageInstanceUpdate(StageInstanceUpdateEvent),
/// A stage instance was deleted.
StageInstanceDelete(StageInstanceDeleteEvent),
/// A thread was created or the current user was added
/// to a private thread.
ThreadCreate(ThreadCreateEvent),
/// A thread was updated.
ThreadUpdate(ThreadUpdateEvent),
/// A thread was deleted.
ThreadDelete(ThreadDeleteEvent),
/// The current user gains access to a channel.
ThreadListSync(ThreadListSyncEvent),
/// The [`ThreadMember`] object for the current user is updated.
ThreadMemberUpdate(ThreadMemberUpdateEvent),
/// Anyone is added to or removed from a thread.
ThreadMembersUpdate(ThreadMembersUpdateEvent),
/// A scheduled event was created.
GuildScheduledEventCreate(GuildScheduledEventCreateEvent),
/// A scheduled event was updated.
GuildScheduledEventUpdate(GuildScheduledEventUpdateEvent),
/// A scheduled event was deleted.
GuildScheduledEventDelete(GuildScheduledEventDeleteEvent),
/// A guild member has subscribed to a scheduled event.
GuildScheduledEventUserAdd(GuildScheduledEventUserAddEvent),
/// A guild member has unsubscribed from a scheduled event.
GuildScheduledEventUserRemove(GuildScheduledEventUserRemoveEvent),
/// A user subscribed to a SKU.
EntitlementCreate(EntitlementCreateEvent),
/// A user's entitlement was updated or renewed.
EntitlementUpdate(EntitlementUpdateEvent),
/// A user's entitlement was deleted by Discord, or refunded.
EntitlementDelete(EntitlementDeleteEvent),
/// An event type not covered by the above
#[serde(untagged)]
Unknown(UnknownEvent),
}
impl Event {
/// Return the event name of this event. Returns [`None`] if the event is
/// [`Unknown`](Event::Unknown).
#[must_use]
pub fn name(&self) -> Option<String> {
if let Self::Unknown(_) = self {
None
} else {
let map = serde_json::to_value(self).ok()?;
Some(map.get("t")?.as_str()?.to_string())
}
}
}