Struct twitch_api2::helix::games::get_top_games::GetTopGamesRequest

#[non_exhaustive]pub struct GetTopGamesRequest {
    pub after: Option<Cursor>,
    pub before: Option<Cursor>,
    pub first: Option<usize>,
}

This is supported on crate feature helix only.

Query Parameters for Get Top Games

get-top-games

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.

after: Option<Cursor>

Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.

before: Option<Cursor>

Cursor for backward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.

first: Option<usize>

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

Implementations

impl GetTopGamesRequest

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

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

Trait Implementations

impl Clone for GetTopGamesRequest

fn clone(&self) -> GetTopGamesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetTopGamesRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GetTopGamesRequest

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

Deserialize this value from the given Serde deserializer.

impl Paginated for GetTopGamesRequest

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

Should returns the current pagination cursor.

impl PartialEq<GetTopGamesRequest> for GetTopGamesRequest

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

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

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

This method tests for !=.

impl Request for GetTopGamesRequest

type Response = Vec<Game>

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

const PATH: &'static str

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

const SCOPE: &'static [Scope]

Scopes needed by this endpoint

const OPT_SCOPE: &'static [Scope]

Optional scopes needed by this endpoint

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

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 GetTopGamesRequest

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

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

fn parse_response(
    request: Option<Self>,
    uri: &Uri,
    response: Response<Vec<u8>>
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
    Self: Sized, 

Parse response. Override for different behavior

impl Serialize for GetTopGamesRequest

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 GetTopGamesRequest