Struct User

#[non_exhaustive]
pub struct User {
    pub broadcaster_type: Option<BroadcasterType>,
    pub created_at: Timestamp,
    pub description: Option<String>,
    pub display_name: DisplayName,
    pub email: Option<String>,
    pub id: UserId,
    pub login: UserName,
    pub offline_image_url: Option<String>,
    pub profile_image_url: Option<String>,
    pub type_: Option<UserType>,
    pub view_count: usize,
}

Available on crate feature helix only.

Return Values for Get Users

get-users

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

broadcaster_type: Option<BroadcasterType>

User’s broadcaster type: “partner”, “affiliate”, or “”.

created_at: Timestamp

Date when the user was created.

description: Option<String>

User’s channel description.

display_name: DisplayName

User’s display name.

email: Option<String>

User’s email address. Returned if the request includes the user:read:email scope.

id: UserId

User’s ID.

login: UserName

User’s login name.

offline_image_url: Option<String>

URL of the user’s offline image.

profile_image_url: Option<String>

URL of the user’s profile image.

type_: Option<UserType>

User’s type: “staff”, “admin”, “global_mod”, or “”.

view_count: usize

👎Deprecated since 0.7.0: removed, see https://discuss.dev.twitch.tv/t/get-users-api-endpoint-view-count-deprecation/37777

Total number of views of the user’s channel.

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for User

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for User

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for User

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for User

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for User

impl StructuralPartialEq for User