Enum twitch_api::eventsub::EventType

#[non_exhaustive]
pub enum EventType {
    ChannelUpdate,
    ChannelFollow,
    ChannelSubscribe,
    ChannelCheer,
    ChannelBan,
    ChannelUnban,
    ChannelPointsCustomRewardAdd,
    ChannelPointsCustomRewardUpdate,
    ChannelPointsCustomRewardRemove,
    ChannelPointsCustomRewardRedemptionAdd,
    ChannelPointsCustomRewardRedemptionUpdate,
    ChannelPollBegin,
    ChannelPollProgress,
    ChannelPollEnd,
    ChannelPredictionBegin,
    ChannelPredictionProgress,
    ChannelPredictionLock,
    ChannelPredictionEnd,
    ChannelRaid,
    ChannelSubscriptionEnd,
    ChannelSubscriptionGift,
    ChannelSubscriptionMessage,
    ChannelGoalBegin,
    ChannelGoalProgress,
    ChannelGoalEnd,
    ChannelHypeTrainBegin,
    ChannelHypeTrainProgress,
    ChannelHypeTrainEnd,
    StreamOnline,
    StreamOffline,
    UserUpdate,
    UserAuthorizationRevoke,
    UserAuthorizationGrant,
}

Available on crate feature eventsub only.

Event Types

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ChannelUpdate

channel.update: subscription type sends notifications when a broadcaster updates the category, title, mature flag, or broadcast language for their channel.

ChannelFollow

channel.follow: a specified channel receives a follow.

ChannelSubscribe

channel.subscribe: a specified channel receives a subscriber. This does not include resubscribes.

ChannelCheer

channel.cheer: a user cheers on the specified channel.

ChannelBan

channel.ban: a viewer is banned from the specified channel.

ChannelUnban

channel.unban: a viewer is unbanned from the specified channel.

ChannelPointsCustomRewardAdd

channel.channel_points_custom_reward.add: a custom channel points reward has been created for the specified channel.

ChannelPointsCustomRewardUpdate

channel.channel_points_custom_reward.update: a custom channel points reward has been updated for the specified channel.

ChannelPointsCustomRewardRemove

channel.channel_points_custom_reward.remove: a custom channel points reward has been removed from the specified channel.

ChannelPointsCustomRewardRedemptionAdd

channel.channel_points_custom_reward_redemption.add: a viewer has redeemed a custom channel points reward on the specified channel.

ChannelPointsCustomRewardRedemptionUpdate

channel.channel_points_custom_reward_redemption.update: a redemption of a channel points custom reward has been updated for the specified channel.

ChannelPollBegin

channel.poll.begin: a poll begins on the specified channel.

ChannelPollProgress

channel.poll.progress: a user responds to a poll on the specified channel.

ChannelPollEnd

channel.poll.end: a poll ends on the specified channel.

ChannelPredictionBegin

channel.prediction.begin: a Prediction begins on the specified channel

ChannelPredictionProgress

channel.prediction.progress: a user participates in a Prediction on the specified channel.

ChannelPredictionLock

channel.prediction.lock: a Prediction is locked on the specified channel.

ChannelPredictionEnd

channel.prediction.end: a Prediction ends on the specified channel.

ChannelRaid

channel.raid: a broadcaster raids another broadcaster’s channel.

ChannelSubscriptionEnd

channel.subscription.end: a subscription to the specified channel expires.

ChannelSubscriptionGift

channel.subscription.gift: a user gives one or more gifted subscriptions in a channel.

ChannelSubscriptionMessage

channel.subscription.message: a user sends a resubscription chat message in a specific channel

ChannelGoalBegin

channel.goal.begin: a goal begins on the specified channel.

ChannelGoalProgress

channel.goal.progress: a goal makes progress on the specified channel.

ChannelGoalEnd

channel.goal.end: a goal ends on the specified channel.

ChannelHypeTrainBegin

channel.hype_train.begin: a hype train begins on the specified channel.

ChannelHypeTrainProgress

channel.hype_train.progress: a hype train makes progress on the specified channel.

ChannelHypeTrainEnd

channel.hype_train.end: a hype train ends on the specified channel.

StreamOnline

stream.online: the specified broadcaster starts a stream.

StreamOffline

stream.offline: the specified broadcaster stops a stream.

UserUpdate

user.update: user updates their account.

UserAuthorizationRevoke

user.authorization.revoke: a user has revoked authorization for your client id. Use this webhook to meet government requirements for handling user data, such as GDPR, LGPD, or CCPA.

UserAuthorizationGrant

user.authorization.grant: a user’s authorization has been granted to your client id.

Implementations

impl EventType

pub const fn to_str(&self) -> &'static str

Get the event string of this event.

fn main() {
    assert_eq!(EventType::ChannelUpdate.to_str(), "channel.update");
    assert_eq!(EventType::ChannelUnban.to_str(), "channel.unban");
}

Trait Implementations

impl Clone for EventType

fn clone(&self) -> EventType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventType

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

Deserialize this value from the given Serde deserializer.

impl Display for EventType

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

Formats the value using the given formatter.

impl FromStr for EventType

type Err = EventTypeParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<EventType> for EventType

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

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

Serialize this value into the given Serde serializer.

impl Copy for EventType

impl Eq for EventType

impl StructuralEq for EventType

impl StructuralPartialEq for EventType