Struct twitchchat::IrcMessage

pub struct IrcMessage<'a> {
    pub raw: MaybeOwned<'a>,
    pub tags: Option<MaybeOwnedIndex>,
    pub prefix: Option<PrefixIndex>,
    pub command: MaybeOwnedIndex,
    pub args: Option<MaybeOwnedIndex>,
    pub data: Option<MaybeOwnedIndex>,
}

A raw irc message @tags :prefix COMMAND args :data\r\n

Fields

raw: MaybeOwned<'a>

The raw string

tags: Option<MaybeOwnedIndex>

Index of the tags

prefix: Option<PrefixIndex>

Index of the prefix

command: MaybeOwnedIndex

Index of the command

args: Option<MaybeOwnedIndex>

Index of the args

data: Option<MaybeOwnedIndex>

Index of the data

Implementations

impl<'a> IrcMessage<'a>

pub fn get_raw(&self) -> &str

Get the raw string

pub fn get_tags(&self) -> Option<&str>

Get the raw tags

pub fn get_prefix(&self) -> Option<&str>

Get the raw prefix

pub fn get_command(&self) -> &str

Get the raw command

pub fn get_args(&self) -> Option<&str>

Get the raw args

pub fn get_data(&self) -> Option<&str>

Get the raw data

pub fn into_inner(self) -> MaybeOwned<'a>

Consumes this type returning the raw MaybeOwned<'a>

pub fn nth_arg(&self, nth: usize) -> Option<&str>

Get the raw 'nth' argument

pub fn nth_arg_index(&self, nth: usize) -> Option<MaybeOwnedIndex>

Get the index of the 'nth' argumnet

impl<'a> IrcMessage<'a>

pub const IRC_READY: &'static str

An IRC Ready event -- 001.

This is sent when you've connected.

pub const READY: &'static str

A Twitch Ready event -- 376.

This is sent by Twitch with your user information.

pub const CAP: &'static str

A capability response -- CAP.

This is sent to acknowledge whether the capability requested is valid and applied to your connections.

pub const CLEAR_CHAT: &'static str

An event when a user was 'purged' from a channel -- CLEARCHAT.

pub const CLEAR_MSG: &'static str

An event when a users' message was removed. -- CLEARMSG.

pub const GLOBAL_USER_STATE: &'static str

An event about your user state -- GLOBALUSERSTATE.

This is sent when you've connected with TAGS capability enabled.

pub const HOST_TARGET: &'static str

An event when a channel host event happens -- HOSTTARGET.

pub const JOIN: &'static str

A Twitch event when a user joins a channel -- JOIN.

pub const NOTICE: &'static str

A message from Twitch -- NOTICE

pub const PART: &'static str

A Twitch event when a user leaves a channel -- PART

pub const PING: &'static str

An event from Twitch which you must reply to -- PING.

If you do not reply to this within a reasonable time, Twitch will disconnect you.

pub const PONG: &'static str

A response from Twitch when you manually ping the server -- PONG.

pub const PRIVMSG: &'static str

The most common event, a user sends a message to a channel -- PRIVMSG.

pub const RECONNECT: &'static str

Twitch requests that you disconnect and reconnect -- RECONNECT.

pub const ROOM_STATE: &'static str

An event about the state of a room -- ROOM_STATE.

pub const USER_NOTICE: &'static str

An event about the state of a user -- USERNOTICE.

pub const USER_STATE: &'static str

An event about the state of a user -- USERSTATE.

pub const WHISPER: &'static str

A message from a user directly to you -- WHISPER.

Trait Implementations

impl<'a> Clone for IrcMessage<'a>

fn clone(&self) -> IrcMessage<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for IrcMessage<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for IrcMessage<'a>

fn deserialize<D>(deserializer: D) -> Result<IrcMessage<'a>, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a> From<IrcMessage<'a>> for Commands<'a>

fn from(msg: IrcMessage<'a>) -> Self

Performs the conversion.

impl<'a> FromIrcMessage<'a> for IrcMessage<'a>

type Error = Infallible

An error returned if this message could not be parsed.

fn from_irc(msg: IrcMessage<'a>) -> Result<Self, Self::Error>

This method consumes an IrcMessage and tries to produce an instance of Self

fn into_inner(self) -> MaybeOwned<'a>

Consumes the message, returning the raw MaybeOwned<'_>

impl<'a> IntoOwned<'a> for IrcMessage<'a>

type Output = IrcMessage<'static>

The output type

fn into_owned(self) -> Self::Output

Consumes self, returning an owned version

impl<'a> PartialEq<IrcMessage<'a>> for IrcMessage<'a>

fn eq(&self, other: &IrcMessage<'a>) -> bool

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

fn ne(&self, other: &IrcMessage<'a>) -> bool

This method tests for !=.

impl<'a> Serialize for IrcMessage<'a>

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

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for IrcMessage<'a>

impl<'a> Validator for IrcMessage<'a>

fn parse_tags(&self) -> TagIndices

Pre-compute the tag indices

fn expect_command(&self, cmd: &str) -> Result<(), MessageError>

You expect a command matching 'cmd'. See the constants in IrcMessage

fn expect_nick(&self) -> Result<MaybeOwnedIndex, MessageError>

You expect a user nickname to be attached. This returns the MaybeOwnedIndex of it

fn expect_arg(&self, nth: usize) -> Result<&str, MessageError>

You expect an argumnet at position 'nth' (0-based). This returns the &str of it.

fn expect_arg_index(&self, nth: usize) -> Result<MaybeOwnedIndex, MessageError>

You expect an argumnet at position 'nth' (0-based). This returns the MaybeOwnedIndex of it.

fn expect_data(&self) -> Result<&str, MessageError>

You expect data to be attached to the message. This returns the &str of it.

fn expect_data_index(&self) -> Result<MaybeOwnedIndex, MessageError>

You expect data to be attached to the message. This returns the MaybeOwnedIndex of it.