twitchchat 0.14.8

interface to the irc-side of twitch's chat system
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

use crate::{irc::*, MaybeOwned, MaybeOwnedIndex, Validator};

/// When a single message has been removed from a channel.
///
/// This is triggered via `/delete` on IRC.
#[derive(Clone, PartialEq)]
pub struct ClearMsg<'a> {
    raw: MaybeOwned<'a>,
    tags: TagIndices,
    channel: MaybeOwnedIndex,
    message: Option<MaybeOwnedIndex>,
}

impl<'a> ClearMsg<'a> {
    raw!();
    tags!();
    str_field!(
        /// The channel this event happened on
        channel
    );
    opt_str_field!(
        /// The message that was deleted
        message
    );

    /// Name of the user who sent the message
    pub fn login(&self) -> Option<&str> {
        self.tags().get("login")
    }

    /// UUID of the message
    pub fn target_msg_id(&self) -> Option<&str> {
        self.tags().get("target-msg-id")
    }
}

impl<'a> FromIrcMessage<'a> for ClearMsg<'a> {
    type Error = MessageError;

    fn from_irc(msg: IrcMessage<'a>) -> Result<Self, Self::Error> {
        msg.expect_command(IrcMessage::CLEAR_MSG)?;

        let this = Self {
            tags: msg.parse_tags(),
            channel: msg.expect_arg_index(0)?,
            message: msg.data,
            raw: msg.raw,
        };

        Ok(this)
    }

    into_inner_raw!();
}

into_owned!(ClearMsg {
    raw,
    tags,
    channel,
    message,
});

impl_custom_debug!(ClearMsg {
    raw,
    tags,
    channel,
    message,
    login,
    target_msg_id,
});

serde_struct!(ClearMsg {
    raw,
    tags,
    channel,
    message,
    login,
    target_msg_id
});

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    #[cfg(feature = "serde")]
    fn clear_msg_serde() {
        let input = ":tmi.twitch.tv CLEARMSG #museun :HeyGuys\r\n";
        crate::serde::round_trip_json::<ClearMsg>(input);
        crate::serde::round_trip_rmp::<ClearMsg>(input);
    }

    #[test]
    fn clear_msg() {
        let input = ":tmi.twitch.tv CLEARMSG #museun :HeyGuys\r\n";
        for msg in parse(input).map(|s| s.unwrap()) {
            let cm = ClearMsg::from_irc(msg).unwrap();
            assert_eq!(cm.channel(), "#museun");
            assert_eq!(cm.message().unwrap(), "HeyGuys");
        }
    }

    #[test]
    fn clear_msg_empty() {
        let input = ":tmi.twitch.tv CLEARMSG #museun\r\n";
        for msg in parse(input).map(|s| s.unwrap()) {
            let cm = ClearMsg::from_irc(msg).unwrap();
            assert_eq!(cm.channel(), "#museun");
            assert!(cm.message().is_none());
        }
    }

    #[test]
    fn clear_msg_uuid() {
        let input =
            "@login=ronni;target-msg-id=abc-123-def :tmi.twitch.tv CLEARMSG #dallas :HeyGuys\r\n";
        for msg in parse(input).map(|s| s.unwrap()) {
            let cm = ClearMsg::from_irc(msg).unwrap();
            assert_eq!(cm.channel(), "#dallas");
            assert_eq!(cm.message().unwrap(), "HeyGuys");
            assert_eq!(cm.target_msg_id().unwrap(), "abc-123-def");
        }
    }
}