tmi 0.10.0

twitch.tv messaging interface
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
115
116
117
118
119
120
121
122
123
124
125
126
127

//! Sent when a single message is deleted.

use super::{maybe_clone, parse_message_text, parse_timestamp, MessageParseError};
use crate::irc::{Command, IrcMessageRef, Tag};
use chrono::{DateTime, Utc};
use std::borrow::Cow;

/// Sent when a single message is deleted.
#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ClearMsg<'src> {
  #[cfg_attr(feature = "serde", serde(borrow))]
  channel: Cow<'src, str>,

  #[cfg_attr(feature = "serde", serde(borrow))]
  channel_id: Cow<'src, str>,

  #[cfg_attr(feature = "serde", serde(borrow))]
  sender: Cow<'src, str>,

  #[cfg_attr(feature = "serde", serde(borrow))]
  target_message_id: Cow<'src, str>,

  #[cfg_attr(feature = "serde", serde(borrow))]
  text: Cow<'src, str>,

  is_action: bool,

  timestamp: DateTime<Utc>,
}

generate_getters! {
  <'src> for ClearMsg<'src> as self {
    /// Login of the channel in which the message was deleted.
    channel -> &str = self.channel.as_ref(),

    /// ID of the channel in which the message was deleted.
    channel_id -> &str = self.channel_id.as_ref(),

    /// Login of the user which sent the deleted message.
    sender -> &str = self.sender.as_ref(),

    /// Unique ID of the deleted message.
    target_message_id -> &str = self.target_message_id.as_ref(),

    /// Text of the deleted message.
    text -> &str = self.text.as_ref(),

    /// Whether the deleted message was sent with `/me`.
    is_action -> bool,

    /// Time at which the [`ClearMsg`] was executed on Twitch servers.
    timestamp -> DateTime<Utc>,
  }
}

impl<'src> ClearMsg<'src> {
  fn parse(message: IrcMessageRef<'src>) -> Option<Self> {
    if message.command() != Command::ClearMsg {
      return None;
    }

    let (text, is_action) = parse_message_text(message.text()?);
    Some(ClearMsg {
      channel: message.channel()?.into(),
      channel_id: message.tag(Tag::RoomId)?.into(),
      sender: message.tag(Tag::Login)?.into(),
      target_message_id: message.tag(Tag::TargetMsgId)?.into(),
      text: text.into(),
      is_action,
      timestamp: parse_timestamp(message.tag(Tag::TmiSentTs)?)?,
    })
  }

  /// Clone data to give the value a `'static` lifetime.
  pub fn into_owned(self) -> ClearMsg<'static> {
    ClearMsg {
      channel: maybe_clone(self.channel),
      channel_id: maybe_clone(self.channel_id),
      sender: maybe_clone(self.sender),
      target_message_id: maybe_clone(self.target_message_id),
      text: maybe_clone(self.text),
      is_action: self.is_action,
      timestamp: self.timestamp,
    }
  }
}

impl<'src> super::FromIrc<'src> for ClearMsg<'src> {
  #[inline]
  fn from_irc(message: IrcMessageRef<'src>) -> Result<Self, MessageParseError> {
    Self::parse(message).ok_or(MessageParseError)
  }
}

impl<'src> From<ClearMsg<'src>> for super::Message<'src> {
  fn from(msg: ClearMsg<'src>) -> Self {
    super::Message::ClearMsg(msg)
  }
}

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

  #[test]
  fn parse_clearmsg_basic() {
    assert_irc_snapshot!(ClearMsg, "@login=alazymeme;room-id=;target-msg-id=3c92014f-340a-4dc3-a9c9-e5cf182f4a84;tmi-sent-ts=1594561955611 :tmi.twitch.tv CLEARMSG #pajlada :lole");
  }

  #[test]
  fn parse_clearmsg_action() {
    assert_irc_snapshot!(ClearMsg, "@login=alazymeme;room-id=;target-msg-id=3c92014f-340a-4dc3-a9c9-e5cf182f4a84;tmi-sent-ts=1594561955611 :tmi.twitch.tv CLEARMSG #pajlada :\u{0001}ACTION lole\u{0001}");
  }

  #[cfg(feature = "serde")]
  #[test]
  fn roundtrip_clearmsg_basic() {
    assert_irc_roundtrip!(ClearMsg, "@login=alazymeme;room-id=;target-msg-id=3c92014f-340a-4dc3-a9c9-e5cf182f4a84;tmi-sent-ts=1594561955611 :tmi.twitch.tv CLEARMSG #pajlada :lole");
  }

  #[cfg(feature = "serde")]
  #[test]
  fn roundtrip_clearmsg_action() {
    assert_irc_roundtrip!(ClearMsg, "@login=alazymeme;room-id=;target-msg-id=3c92014f-340a-4dc3-a9c9-e5cf182f4a84;tmi-sent-ts=1594561955611 :tmi.twitch.tv CLEARMSG #pajlada :\u{0001}ACTION lole\u{0001}");
  }
}