Struct twitch_api2::helix::eventsub::CreateEventSubSubscription

#[non_exhaustive]
pub struct CreateEventSubSubscription<E: EventSubscription> {
    pub id: EventSubId,
    pub status: Status,
    pub type_: EventType,
    pub version: String,
    pub condition: E,
    pub created_at: Timestamp,
    pub transport: TransportResponse,
    pub limit: Option<usize>,
    pub total: usize,
    pub total_cost: usize,
    pub max_total_cost: usize,
    pub cost: usize,
}

Available on crate features helix and eventsub only.

Return Values for Create EventSub Subscription

create-eventsub-subscription

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: EventSubId

ID of the subscription created.

status: Status

Status of the subscription.

type_: EventType

The category of the subscription that was created.

version: String

The version of the subscription type that was created.

condition: E

JSON object specifying custom parameters for the subscription.

created_at: Timestamp

RFC3339 timestamp indicating when the subscription was created.

transport: TransportResponse

JSON object indicating the notification delivery specific information. Includes the transport method and callback URL.

limit: Option<usize>

👎 Deprecated since 0.5.0:

on 2021-05-11, this will no longer be returned. Use max_total_cost instead

Subscription limit for client id that made the subscription creation request.

total: usize

Total number of subscriptions for the client ID that made the subscription creation request.

total_cost: usize

Total cost of all the subscriptions for the client ID that made the subscription creation request.

max_total_cost: usize

The maximum total cost allowed for all of the subscriptions for the client ID that made the subscription creation request.

cost: usize

How much the subscription counts against your limit.

Trait Implementations

impl<E: Clone + EventSubscription> Clone for CreateEventSubSubscription<E>

fn clone(&self) -> CreateEventSubSubscription<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug + EventSubscription> Debug for CreateEventSubSubscription<E>

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

Formats the value using the given formatter.

impl<'de, E: EventSubscription> Deserialize<'de> for CreateEventSubSubscription<E> where
    E: EventSubscription, 

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

Deserialize this value from the given Serde deserializer.

impl<E: PartialEq + EventSubscription> PartialEq<CreateEventSubSubscription<E>> for CreateEventSubSubscription<E>

fn eq(&self, other: &CreateEventSubSubscription<E>) -> bool

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

fn ne(&self, other: &CreateEventSubSubscription<E>) -> bool

This method tests for !=.

impl<E: EventSubscription> Serialize for CreateEventSubSubscription<E> where
    E: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<E: EventSubscription> StructuralPartialEq for CreateEventSubSubscription<E>