twitch-irc 6.0.0

Connect to Twitch chat from a Rust application.
Documentation 
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

use crate::message::commands::IRCMessageParseExt;
use crate::message::{IRCMessage, ServerMessageParseError};
use chrono::{DateTime, Utc};
use std::convert::TryFrom;

#[cfg(feature = "with-serde")]
use {serde::Deserialize, serde::Serialize};

/// Message for when a single message is deleted from chat.
///
/// The deleted message is identified by its `message_id`.
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "with-serde", derive(Serialize, Deserialize))]
pub struct ClearMsgMessage {
    /// Login name of the channel that the deleted message was posted in.
    pub channel_login: String,
    // pub channel_id: String,
    /// login name of the user that sent the original message that was deleted by this
    /// `CLEARMSG`.
    pub sender_login: String,
    /// ID of the message that was deleted.
    pub message_id: String,
    /// Text of the message that was deleted
    pub message_text: String,
    /// Whether the deleted message was an action (`/me`)
    pub is_action: bool,
    /// server timestamp for the time when the delete command was executed.
    pub server_timestamp: DateTime<Utc>,

    /// The message that this `ClearMsgMessage` was parsed from.
    pub source: IRCMessage,
}

impl TryFrom<IRCMessage> for ClearMsgMessage {
    type Error = ServerMessageParseError;

    fn try_from(source: IRCMessage) -> Result<ClearMsgMessage, ServerMessageParseError> {
        if source.command != "CLEARMSG" {
            return Err(ServerMessageParseError::MismatchedCommand(Box::new(source)));
        }

        // example msg:
        // @login=alazymeme;room-id=;target-msg-id=3c92014f-340a-4dc3-a9c9-e5cf182f4a84;tmi-sent-ts=1594561955611 :tmi.twitch.tv CLEARMSG #pajlada :NIGHT CUNT
        // room-id is currently empty on all incoming messages, so we don't parse it
        // see https://github.com/twitchdev/issues/issues/163
        let (message_text, is_action) = source.try_get_message_text()?;

        Ok(ClearMsgMessage {
            channel_login: source.try_get_channel_login()?.to_owned(),
            // channel_id: source.try_get_nonempty_tag_value("room-id")?.to_owned(),
            sender_login: source.try_get_nonempty_tag_value("login")?.to_owned(),
            message_id: source
                .try_get_nonempty_tag_value("target-msg-id")?
                .to_owned(),
            server_timestamp: source.try_get_timestamp("tmi-sent-ts")?,
            message_text: message_text.to_owned(),
            is_action,
            source,
        })
    }
}

impl From<ClearMsgMessage> for IRCMessage {
    fn from(msg: ClearMsgMessage) -> IRCMessage {
        msg.source
    }
}

#[cfg(test)]
mod tests {
    use crate::message::{ClearMsgMessage, IRCMessage};
    use chrono::{TimeZone, Utc};
    use std::convert::TryFrom;

    #[test]
    pub fn test_simple() {
        let src = "@login=alazymeme;room-id=;target-msg-id=3c92014f-340a-4dc3-a9c9-e5cf182f4a84;tmi-sent-ts=1594561955611 :tmi.twitch.tv CLEARMSG #pajlada :NIGHT CUNT";
        let irc_message = IRCMessage::parse(src).unwrap();
        let msg = ClearMsgMessage::try_from(irc_message.clone()).unwrap();

        assert_eq!(
            msg,
            ClearMsgMessage {
                channel_login: "pajlada".to_owned(),
                sender_login: "alazymeme".to_owned(),
                message_id: "3c92014f-340a-4dc3-a9c9-e5cf182f4a84".to_owned(),
                message_text: "NIGHT CUNT".to_owned(),
                is_action: false,
                server_timestamp: Utc.timestamp_millis_opt(1_594_561_955_611).unwrap(),
                source: irc_message
            }
        );
    }

    #[test]
    pub fn test_action() {
        let src = "@login=randers;room-id=;target-msg-id=15e5164d-f8e6-4aec-baf4-2d6a330760c4;tmi-sent-ts=1594562632383 :tmi.twitch.tv CLEARMSG #pajlada :\u{0001}ACTION test\u{0001}";
        let irc_message = IRCMessage::parse(src).unwrap();
        let msg = ClearMsgMessage::try_from(irc_message.clone()).unwrap();

        assert_eq!(
            msg,
            ClearMsgMessage {
                channel_login: "pajlada".to_owned(),
                sender_login: "randers".to_owned(),
                message_id: "15e5164d-f8e6-4aec-baf4-2d6a330760c4".to_owned(),
                message_text: "test".to_owned(),
                is_action: true,
                server_timestamp: Utc.timestamp_millis_opt(1_594_562_632_383).unwrap(),
                source: irc_message
            }
        );
    }
}