Struct ChannelSubscriptionGiftV1Payload

#[non_exhaustive]
pub struct ChannelSubscriptionGiftV1Payload {
    pub broadcaster_user_id: UserId,
    pub broadcaster_user_login: UserName,
    pub broadcaster_user_name: DisplayName,
    pub cumulative_total: Option<i64>,
    pub is_anonymous: bool,
    pub tier: SubscriptionTier,
    pub total: i64,
    pub user_id: Option<UserId>,
    pub user_login: Option<UserName>,
    pub user_name: Option<DisplayName>,
}

Available on crate feature eventsub only.

channel.subscription.gift 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.

broadcaster_user_id: UserId

The broadcaster user ID.

broadcaster_user_login: UserName

The broadcaster login.

broadcaster_user_name: DisplayName

The broadcaster display name.

cumulative_total: Option<i64>

The number of subscriptions gifted by this user in the channel. This value is null for anonymous gifts or if the gifter has opted out of sharing this information.

is_anonymous: bool

Whether the subscription gift was anonymous.

tier: SubscriptionTier

The tier of subscriptions in the subscription gift.

total: i64

The number of subscriptions in the subscription gift.

user_id: Option<UserId>

The user ID of the user who sent the subscription gift. Set to null if it was an anonymous subscription gift.

user_login: Option<UserName>

The user login of the user who sent the gift. Set to null if it was an anonymous subscription gift.

user_name: Option<DisplayName>

The user display name of the user who sent the gift. Set to null if it was an anonymous subscription gift.

Trait Implementations

impl Clone for ChannelSubscriptionGiftV1Payload

fn clone(&self) -> ChannelSubscriptionGiftV1Payload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelSubscriptionGiftV1Payload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelSubscriptionGiftV1Payload

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChannelSubscriptionGiftV1Payload

fn eq(&self, other: &ChannelSubscriptionGiftV1Payload) -> 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 ChannelSubscriptionGiftV1Payload

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 ChannelSubscriptionGiftV1Payload

impl StructuralPartialEq for ChannelSubscriptionGiftV1Payload