Struct twitch_api::eventsub::channel::ChannelBanV1Payload

#[non_exhaustive]
pub struct ChannelBanV1Payload {
    pub user_id: UserId,
    pub user_login: UserName,
    pub user_name: DisplayName,
    pub broadcaster_user_id: UserId,
    pub broadcaster_user_login: UserName,
    pub broadcaster_user_name: DisplayName,
    pub moderator_user_id: UserId,
    pub moderator_user_login: UserName,
    pub moderator_user_name: DisplayName,
    pub reason: String,
    pub ends_at: Option<Timestamp>,
    pub is_permanent: bool,
}

Available on crate feature eventsub only.

channel.ban 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.

user_id: UserId

The user ID for the user who was banned on the specified channel.

user_login: UserName

The user login for the user who was banned on the specified channel.

user_name: DisplayName

The requested broadcaster display name.

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.

moderator_user_id: UserId

The user ID of the issuer of the ban.

moderator_user_login: UserName

The user login of the issuer of the ban.

moderator_user_name: DisplayName

The user name of the issuer of the ban.

reason: String

The reason behind the ban.

ends_at: Option<Timestamp>

Will be null if permanent ban. If it is a timeout, this field shows when the timeout will end.

is_permanent: bool

Indicates whether the ban is permanent (true) or a timeout (false). If true, ends_at will be null.

Trait Implementations

impl Clone for ChannelBanV1Payload

fn clone(&self) -> ChannelBanV1Payload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelBanV1Payload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelBanV1Payload

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<ChannelBanV1Payload> for ChannelBanV1Payload

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

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 ChannelBanV1Payload

impl StructuralEq for ChannelBanV1Payload

impl StructuralPartialEq for ChannelBanV1Payload