Struct twitch_api2::eventsub::channel::ChannelCheerV1Payload

#[non_exhaustive]pub struct ChannelCheerV1Payload {
    pub bits: i64,
    pub broadcaster_user_id: UserId,
    pub broadcaster_user_login: UserName,
    pub broadcaster_user_name: DisplayName,
    pub is_anonymous: bool,
    pub message: String,
    pub user_id: Option<UserId>,
    pub user_login: Option<UserName>,
    pub user_name: Option<DisplayName>,
}

This is supported on crate feature eventsub only.

channel.cheer response payload.

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.

bits: i64

The number of bits cheered.

broadcaster_user_id: UserId

The requested broadcaster ID.

broadcaster_user_login: UserName

The requested broadcaster login.

broadcaster_user_name: DisplayName

The requested broadcaster display name.

is_anonymous: bool

Whether the user cheered anonymously or not.

message: String

The message sent with the cheer.

user_id: Option<UserId>

The user ID for the user who cheered on the specified channel. This is null/empty if is_anonymous is true.

user_login: Option<UserName>

The user login for the user who cheered on the specified channel. This is null/empty if is_anonymous is true.

user_name: Option<DisplayName>

The user display name for the user who cheered on the specified channel. This is null/empty if is_anonymous is true.

Trait Implementations

impl Clone for ChannelCheerV1Payload

fn clone(&self) -> ChannelCheerV1Payload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelCheerV1Payload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelCheerV1Payload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for ChannelCheerV1Payload

impl PartialEq<ChannelCheerV1Payload> for ChannelCheerV1Payload

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

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

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

This method tests for !=.

impl Serialize for ChannelCheerV1Payload

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

Serialize this value into the given Serde serializer.

impl StructuralEq for ChannelCheerV1Payload

impl StructuralPartialEq for ChannelCheerV1Payload