Struct twitch_api2::helix::games::GetGamesRequest

#[non_exhaustive]pub struct GetGamesRequest {
    pub id: Vec<CategoryId>,
    pub name: Vec<String>,
}

This is supported on crate feature helix only.

Query Parameters for Get Games

get-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.

id: Vec<CategoryId>

Game ID. At most 100 id values can be specified.

name: Vec<String>

Game name. The name must be an exact match. For instance, “Pokemon” will not return a list of Pokemon games; instead, query the specific Pokemon game(s) in which you are interested. At most 100 name values can be specified.

Implementations

impl GetGamesRequest

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

Create a builder for building GetGamesRequest. On the builder, call .id(...)(optional), .name(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of GetGamesRequest.

Trait Implementations

impl Clone for GetGamesRequest

fn clone(&self) -> GetGamesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetGamesRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GetGamesRequest

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<GetGamesRequest> for GetGamesRequest

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

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

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

This method tests for !=.

impl Request for GetGamesRequest

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 GetGamesRequest

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 GetGamesRequest

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 GetGamesRequest