Struct twitch_api::eventsub::channel::hypetrain::progress::ChannelHypeTrainProgressV1Payload

#[non_exhaustive]
pub struct ChannelHypeTrainProgressV1Payload {
    pub id: HypeTrainId,
    pub broadcaster_user_id: UserId,
    pub broadcaster_user_login: UserName,
    pub broadcaster_user_name: DisplayName,
    pub expires_at: Timestamp,
    pub goal: i64,
    pub last_contribution: Contribution,
    pub level: i64,
    pub progress: i64,
    pub started_at: Timestamp,
    pub top_contributions: Vec<Contribution>,
    pub total: i64,
}

Available on crate feature eventsub only.

channel.hype_train.progress 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.

id: HypeTrainId

The Hype Train ID.

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.

expires_at: Timestamp

The time at which the hype train expires. The expiration is extended when the hype train reaches a new level.

goal: i64

The number of points required to reach the next level.

last_contribution: Contribution

The most recent contribution.

level: i64

Current level of hype train event.

progress: i64

The number of points contributed to the hype train at the current level.

started_at: Timestamp

The timestamp at which the hype train started.

top_contributions: Vec<Contribution>

The contributors with the most points contributed.

total: i64

Total points contributed to the hype train.

Trait Implementations

impl Clone for ChannelHypeTrainProgressV1Payload

fn clone(&self) -> ChannelHypeTrainProgressV1Payload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelHypeTrainProgressV1Payload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelHypeTrainProgressV1Payload

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<ChannelHypeTrainProgressV1Payload> for ChannelHypeTrainProgressV1Payload

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

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

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

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

impl Serialize for ChannelHypeTrainProgressV1Payload

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 ChannelHypeTrainProgressV1Payload

impl StructuralEq for ChannelHypeTrainProgressV1Payload

impl StructuralPartialEq for ChannelHypeTrainProgressV1Payload