Struct ttv_chat::messages::Privmsg

pub struct Privmsg<'a> { /* fields omitted */ }

Message sent by a user

Implementations

impl<'a> Privmsg<'a>

pub fn raw(&self) -> &str

Get the raw message

pub fn tags(&self) -> Tags<'_>

Get a view of parsable tags

pub fn name(&self) -> &str

User who sent this messages

pub fn channel(&self) -> &str

Channel this message was sent on

pub fn data(&self) -> &str

Data that the user provided

pub fn ctcp(&self) -> Option<Ctcp<'_>>

Gets the 'CTCP' kind associated with this message, if any

pub fn is_action(&self) -> bool

Whether this message was an Action (a /me or /action)

pub fn badge_info(&'a self) -> Vec<Badge<'a>>

Metadata related to the chat badges

Currently used only for subscriber, to indicate the exact number of months the user has been a subscriber

pub fn badges(&'a self) -> Vec<Badge<'a>>

Badges attached to this message

pub fn bits(&self) -> Option<u64>

How many bits were attached to this message

pub fn color(&self) -> Option<Color>

The color of the user who sent this message, if set

pub fn display_name(&'a self) -> Option<&'a str>

Returns the display name of the user, if set.

Users can changed the casing and encoding of their names, if they choose to.

By default, their display name is not set. If the user foo changes their display name to FOO then this'll return that FOO.

Otherwise it'll return None.

pub fn emotes(&self) -> Vec<Emotes>

Emotes attached to this message

pub fn is_broadcaster(&self) -> bool

Whether the user sending this message was a broadcaster

pub fn is_moderator(&self) -> bool

Whether the user sending this message was a moderator

pub fn is_vip(&self) -> bool

Whether the user sending this message was a vip

pub fn is_subscriber(&self) -> bool

Whether the user sending this message was a susbcriber

pub fn is_staff(&self) -> bool

Whether the user sending this message was a staff member

pub fn is_turbo(&self) -> bool

Whether the user sending this message had turbo

pub fn is_global_moderator(&self) -> bool

Whether the user sending this message was a global moderator

pub fn room_id(&self) -> Option<u64>

The id of the room this message was sent to

pub fn tmi_sent_ts(&self) -> Option<u64>

The timestamp of when this message was received by Twitch

pub fn user_id(&self) -> Option<u64>

The id of the user who sent this message

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

custom-reward-id is returned on custom rewards set by broadcaster.

NOTE From the new community points rewards.

With no api from Twitch to retrieve proper name, looks like a UUID.

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

The name of the custom channel reward.

For example, a highlighted message would be highlighted-message

NOTE From the new community points rewards.

Trait Implementations

impl<'a> Clone for Privmsg<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Privmsg<'a>

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

Formats the value using the given formatter.

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

fn from(msg: Privmsg<'a>) -> Commands<'a>

Performs the conversion.

impl<'a> FromIrcMessage<'a> for Privmsg<'a>

type Error = MessageError

An error returned if this message could not be parsed.

fn from_irc(
    msg: IrcMessage<'a>
) -> Result<Privmsg<'a>, <Privmsg<'a> as FromIrcMessage<'a>>::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 Privmsg<'a>

type Output = Privmsg<'static>

The output type

fn into_owned(self) -> <Privmsg<'a> as IntoOwned<'a>>::Output

Consumes self, returning an owned version

impl<'a> PartialEq<Privmsg<'a>> for Privmsg<'a>

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

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

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

This method tests for !=.

impl<'a> StructuralPartialEq for Privmsg<'a>