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

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

/// When a user's message(s) have been purged.
///
/// Typically after a user is banned from chat or timed out
#[derive(Clone, PartialEq)]
pub struct ClearChat<'a> {
    raw: MaybeOwned<'a>,
    tags: TagIndices,
    channel: MaybeOwnedIndex,
    name: Option<MaybeOwnedIndex>,
}

impl<'a> ClearChat<'a> {
    raw!();
    tags!();

    str_field!(
        /// The channel this event happened on
        channel
    );
    opt_str_field!(
        /// The user, if any, that was being purged
        name
    );

    /// (Optional) Duration of the timeout, in seconds. If omitted, the ban is permanent.
    pub fn ban_duration(&self) -> Option<u64> {
        self.tags().get_parsed("ban-duration")
    }

    /// The room id this event happened on
    pub fn room_id(&self) -> Option<&str> {
        self.tags().get("room-id")
    }
}

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

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

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

        Ok(this)
    }

    into_inner_raw!();
}

into_owned!(ClearChat {
    raw,
    tags,
    channel,
    name
});

impl_custom_debug!(ClearChat {
    raw,
    tags,
    channel,
    name,
    ban_duration,
    room_id,
});

serde_struct!(ClearChat {
    raw,
    tags,
    channel,
    name
});

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

    #[test]
    #[cfg(feature = "serde")]
    fn clear_chat_serde() {
        let input = ":tmi.twitch.tv CLEARCHAT #museun :shaken_bot\r\n";
        crate::serde::round_trip_json::<ClearChat>(input);
        crate::serde::round_trip_rmp::<ClearChat>(input);
    }

    #[test]
    fn clear_chat() {
        let input = ":tmi.twitch.tv CLEARCHAT #museun :shaken_bot\r\n";
        for msg in parse(input).map(|s| s.unwrap()) {
            let cc = ClearChat::from_irc(msg).unwrap();
            assert_eq!(cc.channel(), "#museun");
            assert_eq!(cc.name().unwrap(), "shaken_bot");
        }
    }

    #[test]
    fn clear_chat_empty() {
        let input = ":tmi.twitch.tv CLEARCHAT #museun\r\n";
        for msg in parse(input).map(|s| s.unwrap()) {
            let cc = ClearChat::from_irc(msg).unwrap();
            assert_eq!(cc.channel(), "#museun");
            assert!(cc.name().is_none());
        }
    }
}