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

//! Twitch messages that can be parsed from `IrcMessage`, or subscribed to from the `Dispatcher`
//!
//!
//! # Converting from an `IrcMessage` to a specific message
//!
//! ```
//! let input = ":user!user@user PRIVMSG #test_channel :this is some data\r\n";
//! let irc_msg = twitchchat::irc::parse(input).next().unwrap().unwrap();
//!
//! // this is implemented for all of the types in this module
//! use twitchchat::FromIrcMessage;
//! use twitchchat::messages::Privmsg;
//! // this will produce an error if its not this type of message
//! let pm = Privmsg::from_irc(irc_msg).unwrap();
//! assert_eq!(pm.data(), "this is some data");
//! ```
//!
//! # Converting an `IrcMessage` to an enum of all possible messages
//!
//! ```
//! let input = ":user!user@user PRIVMSG #test_channel :this is some data\r\n";
//! let irc_msg = twitchchat::irc::parse(input).next().unwrap().unwrap();
//!
//! // this is implemented for all of the tyupes in this module
//! use twitchchat::FromIrcMessage;
//! use twitchchat::messages::Commands;
//!
//! let all = Commands::from_irc(irc_msg).unwrap();
//! assert!(matches!(all, Commands::Privmsg{..}));
//! ```
//!

mod commands;
pub use commands::Commands;

mod irc_ready;
pub use irc_ready::IrcReady;

mod ready;
pub use ready::Ready;

mod cap;
pub use cap::{Cap, Capability};

mod clear_chat;
pub use clear_chat::ClearChat;

mod clear_msg;
pub use clear_msg::ClearMsg;

mod global_user_state;
pub use global_user_state::GlobalUserState;

mod host_target;
pub use host_target::{HostTarget, HostTargetKind};

mod join;
pub use join::Join;

mod notice;
pub use notice::{MessageId, Notice};

mod part;
pub use part::Part;

mod ping;
pub use ping::Ping;

mod pong;
pub use pong::Pong;

mod privmsg;
pub use privmsg::Privmsg;

mod reconnect;
pub use reconnect::Reconnect;

mod room_state;
pub use room_state::{FollowersOnly, RoomState};

mod user_notice;
pub use user_notice::{NoticeType, SubPlan, UserNotice};

mod user_state;
pub use user_state::UserState;

mod whisper;
pub use whisper::Whisper;

pub use crate::irc::IrcMessage;