Struct Message

pub struct Message<'a> {
    pub raw: Cow<'a, str>,
    pub tags: Tags<'a>,
    pub prefix: Prefix<'a>,
    pub kind: MessageKind<'a>,
    pub args: Vec<Cow<'a, str>>,
    pub data: Option<Cow<'a, str>>,
}

A twitch chat message.

See parse

Fields

raw: Cow<'a, str>

The raw underlying string

tags: Tags<'a>

Metadata embedded in the message

prefix: Prefix<'a>

IRC-styled prefix

kind: MessageKind<'a>

The kind of message

args: Vec<Cow<'a, str>>

Arguments for the message kind

data: Option<Cow<'a, str>>

Data attached to the message

Implementations

impl<'a> Message<'a>

where 'static: 'a,

pub fn as_typed_message<T>(&self) -> Option<T>

where T: TypedMessageMarker<'a>,

Convert this message to a typed message.

Examples

use twitch_message::messages::*;
let data = ":museun!museun@museun PRIVMSG #museun :hello world\r\n";
let message = twitch_message::parse(data)?.message;

let privmsg = message.as_typed_message::<Privmsg>().expect("invalid message");

pub fn as_enum(&self) -> TwitchMessage<'a>

Get this type as an enumeration of all possible types

impl Message<'static>

pub fn into_typed_message<T>( self, ) -> Result<<T as IntoStatic>::Output, Message<'static>>

where Self: 'static, T: TypedMessageMarker<'static>, <T as TryFrom<Self>>::Error: Into<Self>,

Convert this message into an owned typed message.

Examples

use twitch_message::messages::*;
let data = ":museun!museun@museun PRIVMSG #museun :hello world\r\n";
let message = twitch_message::parse(data)?.message;

let privmsg = message.into_typed_message::<Privmsg>().expect("invalid message");

pub fn into_enum(self) -> TwitchMessage<'static>

Convert this type into an enumeration of all possible types

Trait Implementations

impl<'a> Clone for Message<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Message<'a>

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, 'b: 'a> From<&'b Message<'a>> for TwitchMessage<'a>

fn from(ty: &'b Message<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, Message<'a>>> for Message<'static>

fn from(value: Cow<'a, Message<'a>>) -> Self

Converts to this type from the input type.

impl<'a> From<Message<'a>> for TwitchMessage<'a>

fn from(ty: Message<'a>) -> Self

Converts to this type from the input type.

impl<'a> IntoStatic for Message<'a>

where 'static: 'a,

type Output = Message<'static>

Output of IntoStatic::into_static.

fn into_static(self) -> Self::Output

This method casts self between Self<'a> and Self<'static>.

impl<'a> PartialEq for Message<'a>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for Message<'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, 'b> TryFrom<&'b Message<'a>> for Capability<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b> TryFrom<&'b Message<'a>> for ClearChat<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b> TryFrom<&'b Message<'a>> for ClearMsg<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b> TryFrom<&'b Message<'a>> for GlobalUserState<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b> TryFrom<&'b Message<'a>> for HostTarget<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b> TryFrom<&'b Message<'a>> for IrcReady<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b> TryFrom<&'b Message<'a>> for Notice<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b> TryFrom<&'b Message<'a>> for Ping<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b> TryFrom<&'b Message<'a>> for Pong<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b> TryFrom<&'b Message<'a>> for Privmsg<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b> TryFrom<&'b Message<'a>> for Ready<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b> TryFrom<&'b Message<'a>> for Reconnect<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b> TryFrom<&'b Message<'a>> for RoomState<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b> TryFrom<&'b Message<'a>> for UserNotice<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b> TryFrom<&'b Message<'a>> for UserState<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b> TryFrom<&'b Message<'a>> for Whisper<'a>

type Error = &'b Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'b Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for Capability<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for ClearChat<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for ClearMsg<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for GlobalUserState<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for HostTarget<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for IrcReady<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for Notice<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for Ping<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for Pong<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for Privmsg<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for Ready<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for Reconnect<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for RoomState<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for UserNotice<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for UserState<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Message<'a>> for Whisper<'a>

type Error = Message<'a>

The type returned in the event of a conversion error.

fn try_from(value: Message<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Eq for Message<'a>

impl<'a> StructuralPartialEq for Message<'a>