Expand description
Generic and Twitch-specific IRC messages.
Structs§
- Badge
- A single Twitch “badge” to be shown next to the user’s name in chat.
- Clear
Chat Message - Timeout, Permaban or when a chat is entirely cleared.
- Clear
MsgMessage - Message for when a single message is deleted from chat.
- Emote
- A single emote, appearing as part of a message.
- Global
User State Message - Sent once directly after successful login, containing properties for the logged in user.
- IRCMessage
- A protocol-level IRC message, with arbitrary command, parameters, tags and prefix.
- IRCTags
- A map of key-value IRCv3 tags.
- Join
Message - Message received when you successfully join a channel.
- Notice
Message - A user-facing notice sent by the server.
- Part
Message - Message received when you successfully leave (part) a channel.
- Ping
Message - A
PINGconnection-control message. - Pong
Message - A
PONGconnection-control message. - Privmsg
Message - A regular Twitch chat message.
- RGBColor
- An RGB color, used to color chat user’s names.
- Reconnect
Message - Sent by the server to signal a connection to disconnect and reconnect
- Room
State Message - Sent when a channel is initially joined or when a channel updates it state.
- SubGift
Promo - Additionally present on
giftpaidupgradeandanongiftpaidupgrademessages if the upgrade happens as part of a seasonal promotion on Twitch, e.g. Subtember or similar. - Twitch
User Basics - Set of information describing the basic details of a Twitch user.
- User
Notice Message - A Twitch
USERNOTICEmessage. - User
State Message - Sent when you join a channel or when you successfully sent a
PRIVMSGmessage to a channel. - Whisper
Message - A incoming whisper message (a private user-to-user message).
Enums§
- Clear
Chat Action - One of the three types of meaning a
CLEARCHATmessage can have. - Followers
Only Mode - Specifies the followers-only mode a chat is in or was put in.
- IRCParse
Error - Error while parsing a string into an
IRCMessage. - IRCPrefix
- A “prefix” part of an IRC message, as defined by RFC 2812:
- Server
Message - An IRCMessage that has been parsed into a more concrete type based on its command.
- Server
Message Parse Error - Errors encountered while trying to parse an IRC message as a more specialized “server message”, based on its IRC command.
- User
Notice Event - A type of event that a
UserNoticeMessagerepresents.
Traits§
- AsRawIRC
- Anything that can be converted into the raw IRC wire format.
- Reply
ToMessage - Extract the
message_idfrom aPrivmsgMessageor directly use an arbitraryStringor&stras a message ID. This trait allows you to plug both of these types directly intosay_in_reply_to()for your convenience.