Struct twitchchat::commands::PrivMsg

pub struct PrivMsg {
    pub tags: Tags,
    pub user: String,
    pub channel: String,
    pub message: String,
    pub action: bool,
}

Send a message to a channel.

Fields

tags: Tags

IRC tags

user: String

The User that sent this message

channel: String

The channel this message was sent to

message: String

The message body

action: bool

Whether this message was an action (someone doing /me message)

Methods

impl PrivMsg

pub fn user(&self) -> &str

The irc name of the user (generally same as their twitch account name)

pub fn channel(&self) -> &str

The channel this message was sent to

pub fn message(&self) -> &str

The message body

pub fn is_action(&self) -> bool

Whether this message was an action (someone doing /me message)

impl PrivMsg

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

List of badges attached to the user/message

pub fn bits(&self) -> u64

How many bits were attached (0 for None)

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

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

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

The display name of the user, if set

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

List of emotes found in the message body.

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

The unique UUID for this mesage

pub fn moderator(&self) -> bool

Whether this user was a moderator

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

The id for the room

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

The timestamp that this message was received by Twitch

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

The id of the user who sent this message

Trait Implementations

impl Tag for PrivMsg

fn get(&self, key: &str) -> Option<&str>

Gets the key from the mapping, returning the value if found

impl PartialEq<PrivMsg> for PrivMsg

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

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

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

This method tests for !=.

impl From<Message> for PrivMsg

fn from(msg: Message) -> Self

Performs the conversion.

impl Clone for PrivMsg

fn clone(&self) -> PrivMsg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrivMsg

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

Formats the value using the given formatter.