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

use super::*;

/// Message sent by a user
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Whisper<'t> {
    /// User who sent this messages
    pub name: Cow<'t, str>,
    /// Data that the user provided
    pub data: Cow<'t, str>,
    /// Tags attached to the message
    pub tags: Tags<'t>,
}

impl<'t> Whisper<'t> {
    /// Badges attached to this message
    ///    
    pub fn badges(&'t self) -> Vec<crate::Badge<'t>> {
        self.tags
            .get_ref("badges")
            .map(|s| crate::parse_badges(s))
            .unwrap_or_default()
    }

    /// The color of the user who sent this message, if set
    pub fn color(&self) -> Option<crate::color::Color> {
        self.tags.get_parsed("color")
    }

    /// Returns the display name of the user, if set.
    ///
    /// Users can changed the casing and encoding of their names, if they choose to.
    ///
    /// By default, their display name is not set. If the user **foo** changes their display name to **FOO** then this'll return that **FOO**. Otherwise it'll return `None`. This also applies to users who have decided to user a localized version of their name.
    ///
    /// You can get their username with the field [`name`](#structfield.name).
    ///
    /// ```rust
    /// # use twitchchat::{*, messages::*};
    /// // without their display name set
    /// let data = ":foo!foo@foo WHISPER testing :this is a test.\r\n";
    /// let msg = decode(data).next().unwrap().unwrap();
    /// let pm = Whisper::parse(&msg).unwrap();
    /// assert_eq!(pm.name, "foo");
    /// assert!(pm.display_name().is_none());
    ///
    /// // with their display name set
    /// let data = "@display-name=FOO :foo!foo@foo WHISPER testing :this is a test.\r\n";
    /// let msg = decode(data).next().unwrap().unwrap();
    /// let pm = Whisper::parse(&msg).unwrap();
    /// assert_eq!(pm.name, "foo");
    /// assert_eq!(pm.display_name().unwrap(), "FOO");
    /// ```
    ///
    /// A useful thing to do is to try to get the `display_name` and fallback to the `username`.
    ///
    /// ```rust
    /// # use twitchchat::{*, messages::*};
    /// use std::borrow::Cow;
    /// fn get_user_or_display<'a>(msg: &'a Whisper<'_>) -> Cow<'a, str> {
    ///     msg.display_name()
    ///         .unwrap_or_else(|| Cow::Borrowed(&*msg.name))
    /// }
    ///
    /// let data = ":foo!foo@foo WHISPER testing :this is a test.\r\n";
    /// let msg = decode(data).next().unwrap().unwrap();
    /// let pm = Whisper::parse(&msg).unwrap();
    ///
    /// let name = get_user_or_display(&pm);
    /// assert_eq!(name, "foo");
    ///
    /// let data = "@display-name=FOO :foo!foo@foo WHISPER testing :this is a test.\r\n";
    /// let msg = decode(data).next().unwrap().unwrap();
    /// let pm = Whisper::parse(&msg).unwrap();
    ///
    /// let name = get_user_or_display(&pm);
    /// assert_eq!(name, "FOO");    
    /// ```
    pub fn display_name(&'t self) -> Option<Cow<'t, str>> {
        self.tags.get("display-name")
    }

    /// Emotes attached to this message
    pub fn emotes(&self) -> Vec<crate::Emotes> {
        self.tags
            .get("emotes")
            .map(|s| crate::parse_emotes(&s))
            .unwrap_or_default()
    }

    /// Whether the user sending this message was a staff member
    pub fn is_staff(&self) -> bool {
        self.badges()
            .iter()
            .any(|x| x.kind == crate::BadgeKind::Staff)
    }

    /// Whether the user sending this message had turbo
    pub fn is_turbo(&self) -> bool {
        self.badges()
            .iter()
            .any(|x| x.kind == crate::BadgeKind::Turbo)
    }

    /// Whether the user sending this message was a global moderator
    pub fn is_global_moderator(&self) -> bool {
        self.badges()
            .iter()
            .any(|x| x.kind == crate::BadgeKind::GlobalMod)
    }

    /// The timestamp of when this message was received by Twitch
    pub fn tmi_sent_ts(&self) -> Option<u64> {
        self.tags.get_parsed("tmi-sent-ts")
    }

    /// The id of the user who sent this message
    pub fn user_id(&self) -> Option<u64> {
        self.tags.get_parsed("user-id")
    }
}

impl<'a: 't, 't> Parse<&'a Message<'t>> for Whisper<'t> {
    fn parse(msg: &'a Message<'t>) -> Result<Self, InvalidMessage> {
        msg.expect_command("WHISPER")?;
        Ok(Self {
            name: msg.expect_nick()?,
            data: msg.expect_data()?,
            tags: msg.tags.clone(),
        })
    }
}

impl<'t> AsOwned for Whisper<'t> {
    type Owned = Whisper<'static>;
    fn as_owned(&self) -> Self::Owned {
        Whisper {
            name: self.name.as_owned(),
            data: self.data.as_owned(),
            tags: self.tags.as_owned(),
        }
    }
}