Enum twitchchat::irc::types::Message

pub enum Message {
    Ping {
        token: String,
    },
    Cap {
        acknowledge: bool,
        cap: String,
    },
    Connected {
        name: String,
    },
    Ready {
        name: String,
    },
    Unknown {
        prefix: Option<Prefix>,
        tags: Tags,
        head: String,
        args: Vec<String>,
        tail: Option<String>,
    },
}

A simple IRC message

Twitch messages will be part of the Unknown variant.

Variants

Ping

Ping command. The client should respond to this with a PONG :${token}\r\n message

Fields of Ping

token: String

The token sent with the ping, expected to receive back on a PONG

Cap

Acknowledgement (or not) on a CAPS request

Fields of Cap

acknowledge: bool

Whether it was acknowledged

cap: String

Which CAP was enabled

Connected

Happens when you've connected to the server. Corresponds to the 001 IRC message

Fields of Connected

name: String

The name the server assigned you

Ready

Happens after the server sent you the MOTD. Corresponds to the 376 IRC message

Fields of Ready

name: String

The name the server assigned you

Unknown

Unknown message.

Fields of Unknown

prefix: Option<Prefix>

Optional prefix. The sender of the message

tags: Tags

Any parsed tags

head: String

the COMMAND portion of the IRC message

args: Vec<String>

The argument list that follows the commands

tail: Option<String>

Any trailing data (generally after the ':')

Methods

impl Message

pub fn parse(input: &str) -> Option<Self>

Parses an irc message

Trait Implementations

impl ToMessage for IrcMessage

fn tags(&self) -> Option<TagType>

Get the tags portion of the IRC message

fn prefix(&self) -> Option<&str>

Get the prefix portion of the IRC message

fn command(&self) -> Option<&str>

Get the command portion of the IRC message

fn args(&self) -> Option<ArgsType>

Get the args portion of the IRC message

fn data(&self) -> Option<&str>

Get the data portion of the IRC message

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 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.