Struct twitch_api::helix::games::get_games::GetGamesRequest

#[non_exhaustive]
pub struct GetGamesRequest<'a> {
    pub id: Cow<'a, [&'a CategoryIdRef]>,
    pub name: Cow<'a, [&'a str]>,
}

Available 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: Cow<'a, [&'a CategoryIdRef]>

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

name: Cow<'a, [&'a str]>

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<'a> GetGamesRequest<'a>

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

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.

impl<'a> GetGamesRequest<'a>

pub fn names(names: impl Into<Cow<'a, [&'a str]>>) -> Self

Get games with specific exact name match.

pub fn ids(ids: impl Into<Cow<'a, [&'a CategoryIdRef]>>) -> Self

Get games with specific exact id match.

Examples found in repository

src/helix/client/client_ext.rs (line 437)

↕

    pub async fn get_games_by_id<T>(
        &'a self,
        ids: impl AsRef<[&'a types::CategoryIdRef]>,
        token: &T,
    ) -> Result<std::collections::HashMap<types::CategoryId, helix::games::Game>, ClientError<'a, C>>
    where
        T: TwitchToken + ?Sized,
    {
        let ids = ids.as_ref();
        if ids.len() > 100 {
            return Err(ClientRequestError::Custom("too many IDs, max 100".into()));
        }

        let resp = self
            .req_get(helix::games::GetGamesRequest::ids(ids), token)
            .await?;

        Ok(resp
            .data
            .into_iter()
            .map(|g: helix::games::Game| (g.id.clone(), g))
            .collect())
    }

Trait Implementations

impl<'a> Clone for GetGamesRequest<'a>

fn clone(&self) -> GetGamesRequest<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for GetGamesRequest<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for GetGamesRequest<'a>

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

Deserialize this value from the given Serde deserializer.

impl<'a> PartialEq<GetGamesRequest<'a>> for GetGamesRequest<'a>

fn eq(&self, other: &GetGamesRequest<'a>) -> 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 Request for GetGamesRequest<'_>

type Response = Vec<TwitchCategory, Global>

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

const PATH: &'static str = "games"

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 GetGamesRequest<'_>

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.

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

Parse a response string into the response.

impl<'a> Serialize for GetGamesRequest<'a>

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

Serialize this value into the given Serde serializer.

impl<'a> Eq for GetGamesRequest<'a>

impl<'a> StructuralEq for GetGamesRequest<'a>

impl<'a> StructuralPartialEq for GetGamesRequest<'a>