Enum twitchchat::Message

pub enum Message {
    Irc(Message),
    Join(Join),
    Part(Part),
    PrivMsg(PrivMsg),
    Mode(Mode),
    NamesStart(NamesStart),
    NamesEnd(NamesEnd),
    ClearChat(ClearChat),
    ClearMsg(ClearMsg),
    HostTargetStart(HostTargetStart),
    HostTargetEnd(HostTargetEnd),
    Notice(Notice),
    Reconnect(Reconnect),
    RoomState(RoomState),
    UserNotice(UserNotice),
    UserState(UserState),
    GlobalUserState(GlobalUserState),
    // some variants omitted
}

Messages created by the Client.

Wraps commands

Variants

Irc(Message)

An irc Message

Join(Join)

Join a channel.

Part(Part)

Depart from a channel.

PrivMsg(PrivMsg)

Send a message to a channel.

Mode(Mode)

Gain/lose moderator (operator) status in a channel.

NamesStart(NamesStart)

List current chatters in a channel. (begin)

NamesEnd(NamesEnd)

List current chatters in a channel. (end)

ClearChat(ClearChat)

Purge a user's typically after a user is banned from chat or timed out.

ClearMsg(ClearMsg)

Single message removal on a channel. This is triggered via /delete on IRC.

HostTargetStart(HostTargetStart)

Channel starts host mode.

HostTargetEnd(HostTargetEnd)

Channel stops host mode.

Notice(Notice)

General notices from the server.

Reconnect(Reconnect)

Rejoin channels after a restart.

RoomState(RoomState)

Identifies the channel's chat settings (e.g., slow mode duration).

UserNotice(UserNotice)

Announces Twitch-specific events to the channel (e.g., a user's subscription notification).

UserState(UserState)

Identifies a user's chat settings or properties (e.g., chat color)..

GlobalUserState(GlobalUserState)

On successful login.

Methods

impl Message

pub fn parse(msg: impl ToMessage) -> Self

Converts a message into the internal message type, then into the Twitch 'command'

Trait Implementations

impl PartialEq<Message> for Message

fn eq(&self, other: &Message) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Message) -> bool

This method tests for !=.

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<Message> for Join

fn from(msg: Message) -> Self

Performs the conversion.

impl From<Message> for Part

fn from(msg: Message) -> Self

Performs the conversion.

impl From<Message> for PrivMsg

fn from(msg: Message) -> Self

Performs the conversion.

impl From<Message> for Mode

fn from(msg: Message) -> Self

Performs the conversion.

impl From<Message> for NamesStart

fn from(msg: Message) -> Self

Performs the conversion.

impl From<Message> for NamesEnd

fn from(msg: Message) -> Self

Performs the conversion.

impl From<Message> for ClearChat

fn from(msg: Message) -> Self

Performs the conversion.

impl From<Message> for ClearMsg

fn from(msg: Message) -> Self

Performs the conversion.

impl From<Message> for HostTargetStart

fn from(msg: Message) -> Self

Performs the conversion.

impl From<Message> for HostTargetEnd

fn from(msg: Message) -> Self

Performs the conversion.

impl From<Message> for Notice

fn from(msg: Message) -> Self

Performs the conversion.

impl From<Message> for Reconnect

fn from(msg: Message) -> Self

Performs the conversion.

impl From<Message> for RoomState

fn from(msg: Message) -> Self

Performs the conversion.

impl From<Message> for UserNotice

fn from(msg: Message) -> Self

Performs the conversion.

impl From<Message> for UserState

fn from(msg: Message) -> Self

Performs the conversion.

impl From<Message> for GlobalUserState

fn from(msg: Message) -> Self

Performs the conversion.

impl Debug for Message

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for Message

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Message

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.