Struct twitch_api2::helix::eventsub::GetEventSubSubscriptionsRequest

#[non_exhaustive]
pub struct GetEventSubSubscriptionsRequest {
    pub status: Option<Status>,
    pub after: Option<Cursor>,
    pub first: Option<usize>,
}

Available on crate features helix and eventsub only.

Query Parameters for Get EventSub Subscriptions

get-eventsub-subscriptions

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.

status: Option<Status>

Include this parameter to filter subscriptions by their status.

after: Option<Cursor>

Cursor for forward pagination

first: Option<usize>

Maximum number of objects to return. Maximum: 100. Default: 20.

Implementations

impl GetEventSubSubscriptionsRequest

pub fn builder() -> GetEventSubSubscriptionsRequestBuilder<((), (), ())>

Create a builder for building GetEventSubSubscriptionsRequest. On the builder, call .status(...)(optional), .after(...)(optional), .first(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of GetEventSubSubscriptionsRequest.

Trait Implementations

impl Clone for GetEventSubSubscriptionsRequest

fn clone(&self) -> GetEventSubSubscriptionsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetEventSubSubscriptionsRequest

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

Formats the value using the given formatter.

impl Paginated for GetEventSubSubscriptionsRequest

fn set_pagination(&mut self, cursor: Option<Cursor>)

Should returns the current pagination cursor.

impl PartialEq<GetEventSubSubscriptionsRequest> for GetEventSubSubscriptionsRequest

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

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

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

This method tests for !=.

impl Request for GetEventSubSubscriptionsRequest

type Response = EventSubSubscriptions

Response type. twitch’s response will deserialize to this.

const PATH: &'static str = "eventsub/subscriptions"

The path to the endpoint relative to the helix root. eg. channels for Get Channel Information

const SCOPE: &'static [Scope] = &[]

Available on crate feature twitch_oauth2 only.

Scopes needed by this endpoint

const OPT_SCOPE: &'static [Scope] = &[]

Available on crate feature twitch_oauth2 only.

Optional scopes needed by this endpoint

fn query(&self) -> Result<String, SerializeError>

Defines layout of the url parameters.

fn get_uri(&self) -> Result<Uri, InvalidUri>

Returns full URI for the request, including query parameters.

fn get_bare_uri() -> Result<Uri, InvalidUri>

Returns bare URI for the request, NOT including query parameters.

impl RequestGet for GetEventSubSubscriptionsRequest

fn parse_inner_response(
    request: Option<Self>,
    uri: &Uri,
    response: &str,
    status: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
    Self: Sized, 

Parse a response string into the response.

fn create_request(
    &self,
    token: &str,
    client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>

Create a http::Request from this Request in your client

fn parse_response<B: Into<Bytes>>(
    request: Option<Self>,
    uri: &Uri,
    response: Response<B>
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError> where
    Self: Sized, 

Parse response.

impl Serialize for GetEventSubSubscriptionsRequest

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GetEventSubSubscriptionsRequest