Struct twitch_irc::message::TwitchUserBasics

pub struct TwitchUserBasics {
    pub id: String,
    pub login: String,
    pub name: String,
}

Set of information describing the basic details of a Twitch user.

Fields

id: String

The user's unique ID, e.g. 103973901

login: String

The user's login name. For many users, this is simply the lowercased version of their (display) name, but there are also many users where there is no direct relation between login and name.

A Twitch user can change their login and name while still keeping their id constant. For this reason, you should always prefer to use the id to uniquely identify a user, while login and name are variable properties for them.

The login name is used in many places to refer to users, e.g. in the URL for their channel page, or also in almost all places on the Twitch IRC interface (e.g. when sending a message to a channel, you specify the channel by its login name instead of ID).

name: String

Display name of the user. When possible a user should be referred to using this name in user-facing contexts.

This value is never used to uniquely identify a user, and you should avoid making assumptions about the format of this value. For example, the name can contain non-ascii characters, it can contain spaces and it can have spaces at the start and end (albeit rare).

Trait Implementations

impl Clone for TwitchUserBasics

pub fn clone(&self) -> TwitchUserBasics

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TwitchUserBasics

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

Formats the value using the given formatter.

impl PartialEq<TwitchUserBasics> for TwitchUserBasics

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

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

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

This method tests for !=.

impl StructuralPartialEq for TwitchUserBasics