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

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

/// Triggers a commercial.
#[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 Commercial<'a> {
    pub(crate) channel: &'a str,
    pub(crate) length: Option<usize>,
}

/// Triggers a commercial.
///
/// Length *(optional)* must be a positive number of seconds.
pub fn commercial(channel: &str, length: impl Into<Option<usize>>) -> Commercial<'_> {
    Commercial {
        channel,
        length: length.into(),
    }
}

impl<'a> Encodable for Commercial<'a> {
    fn encode<W>(&self, buf: &mut W) -> Result<()>
    where
        W: Write + ?Sized,
    {
        let length = self.length.map(|s| s.to_string());
        write_cmd!(buf, Channel(self.channel) => "/commercial{}", MaybeEmpty(length.as_deref()))
    }
}

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

    #[test]
    fn commercial_encode() {
        test_encode(
            commercial("#museun", None),
            "PRIVMSG #museun :/commercial\r\n",
        );
        test_encode(
            commercial("#museun", 10),
            "PRIVMSG #museun :/commercial 10\r\n",
        );
        test_encode(
            commercial("#museun", Some(10)),
            "PRIVMSG #museun :/commercial 10\r\n",
        );
    }

    #[test]
    fn commercial_ensure_channel_encode() {
        test_encode(
            commercial("museun", None),
            "PRIVMSG #museun :/commercial\r\n",
        );
        test_encode(
            commercial("museun", 10),
            "PRIVMSG #museun :/commercial 10\r\n",
        );
        test_encode(
            commercial("museun", Some(10)),
            "PRIVMSG #museun :/commercial 10\r\n",
        );
    }

    #[test]
    #[cfg(feature = "serde")]
    fn commercial_serde() {
        test_serde(
            commercial("#museun", None),
            "PRIVMSG #museun :/commercial\r\n",
        );
        test_serde(
            commercial("#museun", 10),
            "PRIVMSG #museun :/commercial 10\r\n",
        );
        test_serde(
            commercial("#museun", Some(10)),
            "PRIVMSG #museun :/commercial 10\r\n",
        );
    }

    #[test]
    #[cfg(feature = "serde")]
    fn commercial_ensure_channel_serde() {
        test_serde(
            commercial("museun", None),
            "PRIVMSG #museun :/commercial\r\n",
        );
        test_serde(
            commercial("museun", 10),
            "PRIVMSG #museun :/commercial 10\r\n",
        );
        test_serde(
            commercial("museun", Some(10)),
            "PRIVMSG #museun :/commercial 10\r\n",
        );
    }
}