Struct twitch_irc::message::GlobalUserStateMessage
source · pub struct GlobalUserStateMessage {
pub user_id: String,
pub user_name: String,
pub badge_info: Vec<Badge>,
pub badges: Vec<Badge>,
pub emote_sets: HashSet<String>,
pub name_color: Option<RGBColor>,
pub source: IRCMessage,
}
Expand description
Sent once directly after successful login, containing properties for the logged in user.
This message is not sent if you log into chat as an anonymous user.
Fields§
§user_id: String
ID of the logged in user
user_name: String
Name (also called 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.
However note that subscriber badges are not sent on GLOBALUSERSTATE
messages,
so you can realistically expect this to be empty unless Twitch adds a new feature.
badges: Vec<Badge>
List of badges the logged in user has in all channels.
emote_sets: HashSet<String>
List of emote set IDs the logged in user has available. This always contains at least one entry (“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 GlobalUserStateMessage
was parsed from.
Trait Implementations§
source§impl Clone for GlobalUserStateMessage
impl Clone for GlobalUserStateMessage
source§fn clone(&self) -> GlobalUserStateMessage
fn clone(&self) -> GlobalUserStateMessage
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for GlobalUserStateMessage
impl Debug for GlobalUserStateMessage
source§impl<'de> Deserialize<'de> for GlobalUserStateMessage
impl<'de> Deserialize<'de> for GlobalUserStateMessage
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,
source§impl From<GlobalUserStateMessage> for IRCMessage
impl From<GlobalUserStateMessage> for IRCMessage
source§fn from(msg: GlobalUserStateMessage) -> IRCMessage
fn from(msg: GlobalUserStateMessage) -> IRCMessage
source§impl PartialEq<GlobalUserStateMessage> for GlobalUserStateMessage
impl PartialEq<GlobalUserStateMessage> for GlobalUserStateMessage
source§fn eq(&self, other: &GlobalUserStateMessage) -> bool
fn eq(&self, other: &GlobalUserStateMessage) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl Serialize for GlobalUserStateMessage
impl Serialize for GlobalUserStateMessage
source§impl TryFrom<IRCMessage> for GlobalUserStateMessage
impl TryFrom<IRCMessage> for GlobalUserStateMessage
§type Error = ServerMessageParseError
type Error = ServerMessageParseError
source§fn try_from(
source: IRCMessage
) -> Result<GlobalUserStateMessage, ServerMessageParseError>
fn try_from( source: IRCMessage ) -> Result<GlobalUserStateMessage, ServerMessageParseError>
impl Eq for GlobalUserStateMessage
impl StructuralEq for GlobalUserStateMessage
impl StructuralPartialEq for GlobalUserStateMessage
Auto Trait Implementations§
impl RefUnwindSafe for GlobalUserStateMessage
impl Send for GlobalUserStateMessage
impl Sync for GlobalUserStateMessage
impl Unpin for GlobalUserStateMessage
impl UnwindSafe for GlobalUserStateMessage
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.