Struct twitch_irc::message::UserStateMessage

pub struct UserStateMessage {
    pub channel_login: String,
    pub user_name: String,
    pub badge_info: Vec<Badge>,
    pub badges: Vec<Badge>,
    pub emote_sets: HashSet<u64>,
    pub name_color: Option<RGBColor>,
    pub source: IRCMessage,
}

Sent when you join a channel or when you successfully sent a PRIVMSG message to a channel.

This specifies details about the logged in user in a given channel.

This message is similar to GLOBALUSERSTATE, but carries the context of a channel_login (and therefore possibly different badges and badge_info) and omits the user_id.

Fields

channel_login: String

Login name of the channel this USERSTATE message specifies the logged in user's state in.

user_name: String

(Display) name of the logged in user.

badge_info: Vec<Badge>

Metadata related to the chat badges in the badges tag.

Currently this is used only for subscriber, to indicate the exact number of months the user has been a subscriber. This number is finer grained than the version number in badges. For example, a user who has been a subscriber for 45 months would have a badge_info value of 45 but might have a badges version number for only 3 years.

badges: Vec<Badge>

List of badges the logged in user has in this channel.

emote_sets: HashSet<u64>

List of emote set IDs the logged in user has available. This always contains at least 0.

name_color: Option<RGBColor>

What name color the logged in user has chosen. The same color is used in all channels.

source: IRCMessage

The message that this UserStateMessage was parsed from.

Trait Implementations

impl Clone for UserStateMessage

pub fn clone(&self) -> UserStateMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserStateMessage

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

Formats the value using the given formatter.

impl From<UserStateMessage> for IRCMessage

pub fn from(msg: UserStateMessage) -> IRCMessage

Performs the conversion.

impl PartialEq<UserStateMessage> for UserStateMessage

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

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

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

This method tests for !=.

impl StructuralPartialEq for UserStateMessage

impl TryFrom<IRCMessage> for UserStateMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

pub fn try_from(
    source: IRCMessage
) -> Result<UserStateMessage, ServerMessageParseError>

Performs the conversion.