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
//! Models relating to Discord channels. #[cfg(feature = "http")] use crate::http::CacheHttp; use chrono::{DateTime, FixedOffset}; use crate::{model::prelude::*}; use serde_json::Value; #[cfg(feature = "model")] use crate::builder::{CreateEmbed, EditMessage}; #[cfg(all(feature = "cache", feature = "model"))] use crate::cache::CacheRwLock; #[cfg(all(feature = "cache", feature = "model"))] use parking_lot::RwLock; #[cfg(all(feature = "client", feature = "model"))] use serde_json::json; #[cfg(all(feature = "cache", feature = "model"))] use std::sync::Arc; #[cfg(all(feature = "cache", feature = "model"))] use std::fmt::Write; #[cfg(feature = "model")] use bitflags::__impl_bitflags; #[cfg(feature = "model")] use serde::{ de::{Deserialize, Deserializer}, ser::{Serialize, Serializer}, }; #[cfg(feature = "model")] use super::utils::U64Visitor; #[cfg(feature = "model")] use std::{ mem, result::Result as StdResult, }; #[cfg(feature = "model")] use crate::{ constants, utils as serenity_utils, model::id::{ MessageId, GuildId, ChannelId, }, }; #[cfg(feature = "http")] use crate::http::Http; /// A representation of a message over a guild's text channel, a group, or a /// private channel. #[derive(Clone, Debug, Deserialize, Serialize)] pub struct Message { /// The unique Id of the message. Can be used to calculate the creation date /// of the message. pub id: MessageId, /// An vector of the files attached to a message. pub attachments: Vec<Attachment>, /// The user that sent the message. pub author: User, /// The Id of the [`Channel`] that the message was sent to. /// /// [`Channel`]: enum.Channel.html pub channel_id: ChannelId, /// The content of the message. pub content: String, /// The timestamp of the last time the message was updated, if it was. pub edited_timestamp: Option<DateTime<FixedOffset>>, /// Array of embeds sent with the message. pub embeds: Vec<Embed>, /// The Id of the [`Guild`] that the message was sent in. This value will /// only be present if this message was received over the gateway. /// /// [`Guild`]: ../guild/struct.Guild.html pub guild_id: Option<GuildId>, /// Indicator of the type of message this is, i.e. whether it is a regular /// message or a system message. #[serde(rename = "type")] pub kind: MessageType, /// A partial amount of data about the user's member data, if this message /// was sent in a guild. pub member: Option<PartialMember>, /// Indicator of whether the message mentions everyone. pub mention_everyone: bool, /// Array of [`Role`]s' Ids mentioned in the message. /// /// [`Role`]: ../guild/struct.Role.html pub mention_roles: Vec<RoleId>, /// Channels specifically mentioned in this message. pub mention_channels: Option<Vec<ChannelMention>>, /// Array of users mentioned in the message. pub mentions: Vec<User>, /// Non-repeating number used for ensuring message order. #[serde(default)] pub nonce: Value, /// Indicator of whether the message is pinned. pub pinned: bool, /// Array of reactions performed on the message. #[serde(default)] pub reactions: Vec<MessageReaction>, /// Initial message creation timestamp, calculated from its Id. pub timestamp: DateTime<FixedOffset>, /// Indicator of whether the command is to be played back via /// text-to-speech. /// /// In the client, this is done via the `/tts` slash command. pub tts: bool, /// The Id of the webhook that sent this message, if one did. pub webhook_id: Option<WebhookId>, /// Sent with Rich Presence-related chat embeds. pub activity: Option<MessageActivity>, /// Sent with Rich Presence-related chat embeds. pub application: Option<MessageApplication>, /// Reference data sent with crossposted messages. pub message_reference: Option<MessageReference>, /// Bit flags describing extra features of the message. pub flags: Option<MessageFlags>, #[serde(skip)] pub(crate) _nonexhaustive: (), } #[cfg(feature = "model")] impl Message { /// Retrieves the related channel located in the cache. /// /// Returns `None` if the channel is not in the cache. #[cfg(feature = "cache")] #[inline] pub fn channel(&self, cache: impl AsRef<CacheRwLock>) -> Option<Channel> { cache.as_ref().read().channel(self.channel_id) } /// A util function for determining whether this message was sent by someone else, or the /// bot. #[cfg(all(feature = "cache", feature = "utils"))] pub fn is_own(&self, cache: impl AsRef<CacheRwLock>) -> bool { self.author.id == cache.as_ref().read().user.id } /// Deletes the message. /// /// **Note**: The logged in user must either be the author of the message or /// have the [Manage Messages] permission. /// /// # Errors /// /// If the `cache` feature is enabled, then returns a /// [`ModelError::InvalidPermissions`] if the current user does not have /// the required permissions. /// /// [`ModelError::InvalidPermissions`]: ../error/enum.Error.html#variant.InvalidPermissions /// [`ModelError::InvalidUser`]: ../error/enum.Error.html#variant.InvalidUser /// [Manage Messages]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_MESSAGES #[cfg(feature = "http")] pub fn delete(&self, cache_http: impl CacheHttp) -> Result<()> { #[cfg(feature = "cache")] { if let Some(cache) = cache_http.cache() { let req = Permissions::MANAGE_MESSAGES; let is_author = self.author.id == cache.read().user.id; let has_perms = utils::user_has_perms(&cache, self.channel_id, self.guild_id, req)?; if !is_author && !has_perms { return Err(Error::Model(ModelError::InvalidPermissions(req))); } } } self.channel_id.delete_message(&cache_http.http(), self.id) } /// Deletes all of the [`Reaction`]s associated with the message. /// /// **Note**: Requires the [Manage Messages] permission. /// /// # Errors /// /// If the `cache` feature is enabled, then returns a /// [`ModelError::InvalidPermissions`] if the current user does not have /// the required permissions. /// /// [`ModelError::InvalidPermissions`]: ../error/enum.Error.html#variant.InvalidPermissions /// [`Reaction`]: struct.Reaction.html /// [Manage Messages]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_MESSAGES #[cfg(feature = "http")] pub fn delete_reactions(&self, cache_http: impl CacheHttp) -> Result<()> { #[cfg(feature = "cache")] { if let Some(cache) = cache_http.cache() { let req = Permissions::MANAGE_MESSAGES; if !utils::user_has_perms(cache, self.channel_id, self.guild_id, req)? { return Err(Error::Model(ModelError::InvalidPermissions(req))); } } } cache_http.http().as_ref().delete_message_reactions(self.channel_id.0, self.id.0) } /// Edits this message, replacing the original content with new content. /// /// Message editing preserves all unchanged message data. /// /// Refer to the documentation for [`EditMessage`] for more information /// regarding message restrictions and requirements. /// /// **Note**: Requires that the current user be the author of the message. /// /// # Examples /// /// Edit a message with new content: /// /// ```rust,ignore /// // assuming a `message` has already been bound /// /// message.edit(&context, |m| m.content("new content")); /// ``` /// /// # Errors /// /// If the `cache` is enabled, returns a [`ModelError::InvalidUser`] if the /// current user is not the author. /// /// Returns a [`ModelError::MessageTooLong`] if the content of the message /// is over [`the limit`], containing the number of unicode code points /// over the limit. /// /// [`ModelError::InvalidUser`]: ../error/enum.Error.html#variant.InvalidUser /// [`ModelError::MessageTooLong`]: ../error/enum.Error.html#variant.MessageTooLong /// [`EditMessage`]: ../../builder/struct.EditMessage.html /// [`the limit`]: ../../builder/struct.EditMessage.html#method.content #[cfg(feature = "client")] pub fn edit<F>(&mut self, cache_http: impl CacheHttp, f: F) -> Result<()> where F: FnOnce(&mut EditMessage) -> &mut EditMessage { #[cfg(feature = "cache")] { if let Some(cache) = cache_http.cache() { if self.author.id != cache.read().user.id { return Err(Error::Model(ModelError::InvalidUser)); } } } let mut builder = EditMessage::default(); if !self.content.is_empty() { builder.content(&self.content); } if let Some(embed) = self.embeds.get(0) { let embed = CreateEmbed::from(embed.clone()); builder.embed( |e| { *e = embed; e }); } f(&mut builder); let map = serenity_utils::hashmap_to_json_map(builder.0); match cache_http.http().edit_message(self.channel_id.0, self.id.0, &Value::Object(map)) { Ok(edited) => { mem::replace(self, edited); Ok(()) }, Err(why) => Err(why), } } pub(crate) fn transform_content(&mut self) { match self.kind { MessageType::PinsAdd => { self.content = format!( "{} pinned a message to this channel. See all the pins.", self.author ); }, MessageType::MemberJoin => { let sec = self.timestamp.timestamp() as usize; let chosen = constants::JOIN_MESSAGES[sec % constants::JOIN_MESSAGES.len()]; self.content = if chosen.contains("$user") { chosen.replace("$user", &self.author.mention()) } else { chosen.to_string() }; }, _ => {}, } } /// Returns message content, but with user and role mentions replaced with /// names and everyone/here mentions cancelled. #[cfg(feature = "cache")] pub fn content_safe(&self, cache: impl AsRef<CacheRwLock>) -> String { let mut result = self.content.clone(); // First replace all user mentions. for u in &self.mentions { let mut at_distinct = String::with_capacity(38); at_distinct.push('@'); at_distinct.push_str(&u.name); at_distinct.push('#'); let _ = write!(at_distinct, "{:04}", u.discriminator); let mut m = u.mention(); // Check whether we're replacing a nickname mention or a normal mention. // `UserId::mention` returns a normal mention. If it isn't present in the message, it's a nickname mention. if !result.contains(&m) { m.insert(2, '!'); } result = result.replace(&m, &at_distinct); } // Then replace all role mentions. for id in &self.mention_roles { let mention = id.mention(); if let Some(role) = id.to_role_cached(&cache) { result = result.replace(&mention, &format!("@{}", role.name)); } else { result = result.replace(&mention, "@deleted-role"); } } // And finally replace everyone and here mentions. result .replace("@everyone", "@\u{200B}everyone") .replace("@here", "@\u{200B}here") } /// Gets the list of [`User`]s who have reacted to a [`Message`] with a /// certain [`Emoji`]. /// /// The default `limit` is `50` - specify otherwise to receive a different /// maximum number of users. The maximum that may be retrieve at a time is /// `100`, if a greater number is provided then it is automatically reduced. /// /// The optional `after` attribute is to retrieve the users after a certain /// user. This is useful for pagination. /// /// **Note**: Requires the [Read Message History] permission. /// /// [`Emoji`]: ../guild/struct.Emoji.html /// [`Message`]: struct.Message.html /// [`User`]: ../user/struct.User.html /// [Read Message History]: ../permissions/struct.Permissions.html#associatedconstant.READ_MESSAGE_HISTORY #[cfg(feature = "http")] #[inline] pub fn reaction_users<R, U>( &self, http: impl AsRef<Http>, reaction_type: R, limit: Option<u8>, after: U, ) -> Result<Vec<User>> where R: Into<ReactionType>, U: Into<Option<UserId>> { self.channel_id.reaction_users(&http, self.id, reaction_type, limit, after) } /// Returns the associated `Guild` for the message if one is in the cache. /// /// Returns `None` if the guild's Id could not be found via [`guild_id`] or /// if the Guild itself is not cached. /// /// Requires the `cache` feature be enabled. /// /// [`guild_id`]: #structfield.guild_id #[cfg(feature = "cache")] pub fn guild(&self, cache: impl AsRef<CacheRwLock>) -> Option<Arc<RwLock<Guild>>> { cache.as_ref().read().guild(self.guild_id?) } /// True if message was sent using direct messages. pub fn is_private(&self) -> bool { self.guild_id.is_none() } /// Retrieves a clone of the author's Member instance, if this message was /// sent in a guild. /// /// Note that since this clones, it is preferable performance-wise to /// manually retrieve the guild from the cache and access /// [`Guild::members`]. /// /// [`Guild::members`]: ../guild/struct.Guild.html#structfield.members #[cfg(feature = "cache")] pub fn member(&self, cache: impl AsRef<CacheRwLock>) -> Option<Member> { self.guild(&cache).and_then(|g| g.read().members.get(&self.author.id).cloned()) } /// Checks the length of a string to ensure that it is within Discord's /// maximum message length limit. /// /// Returns `None` if the message is within the limit, otherwise returns /// `Some` with an inner value of how many unicode code points the message /// is over. pub fn overflow_length(content: &str) -> Option<u64> { // Check if the content is over the maximum number of unicode code // points. let count = content.chars().count() as i64; let diff = count - i64::from(constants::MESSAGE_CODE_LIMIT); if diff > 0 { Some(diff as u64) } else { None } } /// Pins this message to its channel. /// /// **Note**: Requires the [Manage Messages] permission. /// /// # Errors /// /// If the `cache` is enabled, returns a /// [`ModelError::InvalidPermissions`] if the current user does not have /// the required permissions. /// /// [`ModelError::InvalidPermissions`]: ../error/enum.Error.html#variant.InvalidPermissions /// [Manage Messages]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_MESSAGES.html #[cfg(feature = "http")] pub fn pin(&self, cache_http: impl CacheHttp) -> Result<()> { #[cfg(feature = "cache")] { if let Some(cache) = cache_http.cache() { if self.guild_id.is_some() { let req = Permissions::MANAGE_MESSAGES; if !utils::user_has_perms(&cache, self.channel_id, self.guild_id, req)? { return Err(Error::Model(ModelError::InvalidPermissions(req))); } } } } self.channel_id.pin(cache_http.http(), self.id.0) } /// React to the message with a custom [`Emoji`] or unicode character. /// /// **Note**: Requires the [Add Reactions] permission. /// /// # Errors /// /// If the `cache` is enabled, returns a /// [`ModelError::InvalidPermissions`] if the current user does not have the /// required [permissions]. /// /// [`ModelError::InvalidPermissions`]: ../error/enum.Error.html#variant.InvalidPermissions /// [`Emoji`]: ../guild/struct.Emoji.html /// [Add Reactions]: /// ../permissions/struct.Permissions.html#associatedconstant.ADD_REACTIONS /// [permissions]: ../permissions/index.html #[inline] #[cfg(feature = "client")] pub fn react<R: Into<ReactionType>>(&self, cache_http: impl CacheHttp, reaction_type: R) -> Result<()> { self._react(cache_http, &reaction_type.into()) } #[cfg(feature = "client")] fn _react(&self, cache_http: impl CacheHttp, reaction_type: &ReactionType) -> Result<()> { #[cfg(feature = "cache")] { if let Some(cache) = cache_http.cache() { if self.guild_id.is_some() { let req = Permissions::ADD_REACTIONS; if !utils::user_has_perms(cache, self.channel_id, self.guild_id, req)? { return Err(Error::Model(ModelError::InvalidPermissions(req))); } } } } cache_http.http().create_reaction(self.channel_id.0, self.id.0, reaction_type) } /// Replies to the user, mentioning them prior to the content in the form /// of: `@<USER_ID>: YOUR_CONTENT`. /// /// User mentions are generally around 20 or 21 characters long. /// /// **Note**: Requires the [Send Messages] permission. /// /// **Note**: Message contents must be under 2000 unicode code points. /// /// # Errors /// /// If the `cache` is enabled, returns a /// [`ModelError::InvalidPermissions`] if the current user does not have /// the required permissions. /// /// Returns a [`ModelError::MessageTooLong`] if the content of the message /// is over the above limit, containing the number of unicode code points /// over the limit. /// /// [`ModelError::InvalidPermissions`]: ../error/enum.Error.html#variant.InvalidPermissions /// [`ModelError::MessageTooLong`]: ../error/enum.Error.html#variant.MessageTooLong /// [Send Messages]: ../permissions/struct.Permissions.html#associatedconstant.SEND_MESSAGES #[cfg(feature = "client")] pub fn reply(&self, cache_http: impl CacheHttp, content: impl AsRef<str>) -> Result<Message> { let content = content.as_ref(); if let Some(length_over) = Message::overflow_length(content) { return Err(Error::Model(ModelError::MessageTooLong(length_over))); } #[cfg(feature = "cache")] { if let Some(cache) = cache_http.cache() { if self.guild_id.is_some() { let req = Permissions::SEND_MESSAGES; if !utils::user_has_perms(cache, self.channel_id, self.guild_id, req)? { return Err(Error::Model(ModelError::InvalidPermissions(req))); } } } } let mut gen = self.author.mention(); gen.push_str(": "); gen.push_str(content); let map = json!({ "content": gen, "tts": false, }); cache_http.http().send_message(self.channel_id.0, &map) } /// Checks whether the message mentions passed [`UserId`]. /// /// [`UserId`]: ../id/struct.UserId.html #[inline] pub fn mentions_user_id<I: Into<UserId>>(&self, id: I) -> bool { self._mentions_user_id(id.into()) } fn _mentions_user_id(&self, id: UserId) -> bool { self.mentions.iter().any(|mentioned_user| mentioned_user.id.0 == id.0) } /// Checks whether the message mentions passed [`User`]. /// /// [`User`]: ../user/struct.User.html pub fn mentions_user(&self, user: &User) -> bool { self.mentions_user_id(user.id) } /// Unpins the message from its channel. /// /// **Note**: Requires the [Manage Messages] permission. /// /// # Errors /// /// If the `cache` is enabled, returns a /// [`ModelError::InvalidPermissions`] if the current user does not have /// the required permissions. /// /// [`ModelError::InvalidPermissions`]: ../error/enum.Error.html#variant.InvalidPermissions /// [Manage Messages]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_MESSAGES #[cfg(feature = "http")] pub fn unpin(&self, cache_http: impl CacheHttp) -> Result<()> { #[cfg(feature = "cache")] { if let Some(cache) = cache_http.cache() { if self.guild_id.is_some() { let req = Permissions::MANAGE_MESSAGES; if !utils::user_has_perms(cache, self.channel_id, self.guild_id, req)? { return Err(Error::Model(ModelError::InvalidPermissions(req))); } } } } cache_http.http().unpin_message(self.channel_id.0, self.id.0) } /// Tries to return author's nickname in the current channel's guild. /// /// **Note**: /// If message was sent in a private channel, then the function will return /// `None`. #[cfg(feature = "http")] pub fn author_nick(&self, cache_http: impl CacheHttp) -> Option<String> { self.guild_id.as_ref().and_then(|guild_id| self.author.nick_in(cache_http, *guild_id)) } pub(crate) fn check_content_length(map: &JsonMap) -> Result<()> { if let Some(content) = map.get("content") { if let Value::String(ref content) = *content { if let Some(length_over) = Message::overflow_length(content) { return Err(Error::Model(ModelError::MessageTooLong(length_over))); } } } Ok(()) } pub(crate) fn check_embed_length(map: &JsonMap) -> Result<()> { let embed = match map.get("embed") { Some(&Value::Object(ref value)) => value, _ => return Ok(()), }; let mut total: usize = 0; if let Some(&Value::Object(ref author)) = embed.get("author") { if let Some(&Value::Object(ref name)) = author.get("name") { total += name.len(); } } if let Some(&Value::String(ref description)) = embed.get("description") { total += description.len(); } if let Some(&Value::Array(ref fields)) = embed.get("fields") { for field_as_value in fields { if let Value::Object(ref field) = *field_as_value { if let Some(&Value::String(ref field_name)) = field.get("name") { total += field_name.len(); } if let Some(&Value::String(ref field_value)) = field.get("value") { total += field_value.len(); } } } } if let Some(&Value::Object(ref footer)) = embed.get("footer") { if let Some(&Value::String(ref text)) = footer.get("text") { total += text.len(); } } if let Some(&Value::String(ref title)) = embed.get("title") { total += title.len(); } if total <= constants::EMBED_MAX_LENGTH as usize { Ok(()) } else { let overflow = total as u64 - u64::from(constants::EMBED_MAX_LENGTH); Err(Error::Model(ModelError::EmbedTooLarge(overflow))) } } } impl AsRef<MessageId> for Message { fn as_ref(&self) -> &MessageId { &self.id } } impl From<Message> for MessageId { /// Gets the Id of a `Message`. fn from(message: Message) -> MessageId { message.id } } impl<'a> From<&'a Message> for MessageId { /// Gets the Id of a `Message`. fn from(message: &Message) -> MessageId { message.id } } /// A representation of a reaction to a message. /// /// Multiple of the same [reaction type] are sent into one `MessageReaction`, /// with an associated [`count`]. /// /// [`count`]: #structfield.count /// [reaction type]: enum.ReactionType.html #[derive(Clone, Debug, Deserialize, Serialize)] pub struct MessageReaction { /// The amount of the type of reaction that have been sent for the /// associated message. pub count: u64, /// Indicator of whether the current user has sent the type of reaction. pub me: bool, /// The type of reaction. #[serde(rename = "emoji")] pub reaction_type: ReactionType, #[serde(skip)] pub(crate) _nonexhaustive: (), } /// Differentiates between regular and different types of system messages. #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)] pub enum MessageType { /// A regular message. Regular = 0, /// An indicator that a recipient was added by the author. GroupRecipientAddition = 1, /// An indicator that a recipient was removed by the author. GroupRecipientRemoval = 2, /// An indicator that a call was started by the author. GroupCallCreation = 3, /// An indicator that the group name was modified by the author. GroupNameUpdate = 4, /// An indicator that the group icon was modified by the author. GroupIconUpdate = 5, /// An indicator that a message was pinned by the author. PinsAdd = 6, /// An indicator that a member joined the guild. MemberJoin = 7, /// An indicator that someone has boosted the guild. NitroBoost = 8, /// An indicator that the guild has reached nitro tier 1 NitroTier1 = 9, /// An indicator that the guild has reached nitro tier 2 NitroTier2 = 10, /// An indicator that the guild has reached nitro tier 3 NitroTier3 = 11, #[doc(hidden)] __Nonexhaustive, } enum_number!( MessageType { Regular, GroupRecipientAddition, GroupRecipientRemoval, GroupCallCreation, GroupNameUpdate, GroupIconUpdate, PinsAdd, MemberJoin, NitroBoost, NitroTier1, NitroTier2, NitroTier3, } ); impl MessageType { pub fn num(self) -> u64 { use self::MessageType::*; match self { Regular => 0, GroupRecipientAddition => 1, GroupRecipientRemoval => 2, GroupCallCreation => 3, GroupNameUpdate => 4, GroupIconUpdate => 5, PinsAdd => 6, MemberJoin => 7, NitroBoost => 8, NitroTier1 => 9, NitroTier2 => 10, NitroTier3 => 11, __Nonexhaustive => unreachable!(), } } } #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)] pub enum MessageActivityKind { JOIN = 1, SPECTATE = 2, LISTEN = 3, #[allow(non_camel_case_types)] JOIN_REQUEST = 5, #[doc(hidden)] __Nonexhaustive, } enum_number!( MessageActivityKind { JOIN, SPECTATE, LISTEN, JOIN_REQUEST, } ); impl MessageActivityKind { pub fn num(self) -> u64 { use self::MessageActivityKind::*; match self { JOIN => 1, SPECTATE => 2, LISTEN => 3, JOIN_REQUEST => 5, __Nonexhaustive => unreachable!(), } } } /// Rich Presence application information. #[derive(Clone, Debug, Deserialize, Serialize)] pub struct MessageApplication { /// ID of the application. pub id: u64, /// ID of the embed's image asset. pub cover_image: Option<String>, /// Application's description. pub description: String, /// ID of the application's icon. pub icon: Option<String>, /// Name of the application. pub name: String, #[serde(skip)] pub(crate) _nonexhaustive: (), } /// Rich Presence activity information. #[derive(Clone, Debug, Deserialize, Serialize)] pub struct MessageActivity { /// Kind of message activity. #[serde(rename = "type")] pub kind: MessageActivityKind, /// `party_id` from a Rich Presence event. pub party_id: Option<String>, #[serde(skip)] pub(crate) _nonexhaustive: (), } /// Reference data sent with crossposted messages. #[derive(Clone, Debug, Deserialize, Serialize)] pub struct MessageReference { /// ID of the originating message. pub message_id: Option<MessageId>, /// ID of the originating message's channel. pub channel_id: ChannelId, /// ID of the originating message's guild. pub guild_id: Option<GuildId>, #[serde(skip)] pub(crate) _nonexhaustive: (), } /// Channel Mention Object #[derive(Clone, Debug, Deserialize, Serialize)] pub struct ChannelMention { /// ID of the channel. pub id: ChannelId, /// ID of the guild containing the channel. pub guild_id: GuildId, /// The kind of channel #[serde(rename = "kind")] pub kind: ChannelType, /// The name of the channel pub name: String, } /// Describes extra features of the message. #[derive(Copy, PartialEq, Eq, Clone, PartialOrd, Ord, Hash)] #[cfg_attr(not(feature = "model"), derive(Debug, Deserialize, Serialize))] pub struct MessageFlags { pub bits: u64, } #[cfg(feature = "model")] __impl_bitflags! { MessageFlags: u64 { /// This message has been published to subscribed channels (via Channel Following). CROSSPOSTED = 0b0000_0000_0000_0000_0000_0000_0000_0001; /// This message originated from a message in another channel (via Channel Following). IS_CROSSPOST = 0b0000_0000_0000_0000_0000_0000_0000_0010; /// Do not include any embeds when serializing this message. SUPPRESS_EMBEDS = 0b0000_0000_0000_0000_0000_0000_0000_0100; } } #[cfg(feature = "model")] impl<'de> Deserialize<'de> for MessageFlags { fn deserialize<D>(deserializer: D) -> StdResult<Self, D::Error> where D: Deserializer<'de> { Ok(MessageFlags::from_bits_truncate( deserializer.deserialize_u64(U64Visitor)?, )) } } #[cfg(feature = "model")] impl Serialize for MessageFlags { fn serialize<S>(&self, serializer: S) -> StdResult<S::Ok, S::Error> where S: Serializer { serializer.serialize_u64(self.bits()) } }