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

use super::{Channel, Encodable};
use std::io::{Result, Write};

/// Enables slow mode (limit how often users may send messages).
#[non_exhaustive]
#[must_use = "commands must be encoded"]
#[derive(Debug, Copy, Clone, PartialEq, Ord, PartialOrd, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(::serde::Deserialize))]
pub struct Slow<'a> {
    pub(crate) channel: &'a str,
    pub(crate) duration: usize,
}

/// Enables slow mode (limit how often users may send messages).
///
/// Duration (optional, **default=120**) must be a positive number of seconds.
///
/// Use [slow_off] to disable.
///
/// [slow_off]: super::slow_off()
pub fn slow(channel: &str, duration: impl Into<Option<usize>>) -> Slow<'_> {
    Slow {
        channel,
        duration: duration.into().unwrap_or(120),
    }
}

impl<'a> Encodable for Slow<'a> {
    fn encode<W>(&self, buf: &mut W) -> Result<()>
    where
        W: Write + ?Sized,
    {
        write_cmd!(
            buf,
            Channel(self.channel) =>
            "/slow {}",
            &self.duration.to_string()
        )
    }
}

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

    #[test]
    fn slow_encode() {
        test_encode(slow("#museun", Some(42)), "PRIVMSG #museun :/slow 42\r\n");
        test_encode(slow("#museun", 42), "PRIVMSG #museun :/slow 42\r\n");
        test_encode(slow("#museun", None), "PRIVMSG #museun :/slow 120\r\n");
    }

    #[test]
    fn slow_ensure_channel_encode() {
        test_encode(slow("museun", Some(42)), "PRIVMSG #museun :/slow 42\r\n");
        test_encode(slow("museun", 42), "PRIVMSG #museun :/slow 42\r\n");
        test_encode(slow("museun", None), "PRIVMSG #museun :/slow 120\r\n");
    }

    #[test]
    #[cfg(feature = "serde")]
    fn slow_serde() {
        test_serde(slow("#museun", Some(42)), "PRIVMSG #museun :/slow 42\r\n");
        test_serde(slow("#museun", 42), "PRIVMSG #museun :/slow 42\r\n");
        test_serde(slow("#museun", None), "PRIVMSG #museun :/slow 120\r\n");
    }

    #[test]
    #[cfg(feature = "serde")]
    fn slow_ensure_channel_serde() {
        test_serde(slow("museun", Some(42)), "PRIVMSG #museun :/slow 42\r\n");
        test_serde(slow("museun", 42), "PRIVMSG #museun :/slow 42\r\n");
        test_serde(slow("museun", None), "PRIVMSG #museun :/slow 120\r\n");
    }
}