1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
//! Gets games sorted by number of current viewers on Twitch, most popular first. //! [`get-top-games`](https://dev.twitch.tv/docs/api/reference#get-top-games) //! //! # Accessing the endpoint //! //! ## Request: [GetTopGamesRequest] //! //! To use this endpoint, construct a [`GetTopGamesRequest`] with the [`GetTopGamesRequest::builder()`] method. //! //! ```rust, no_run //! use twitch_api2::helix::games::get_top_games; //! let request = get_top_games::GetTopGamesRequest::builder() //! .first(100) //! .build(); //! ``` //! //! ## Response: [Game](types::TwitchCategory) //! //! Send the request to receive the response with [`HelixClient::req_get()`](helix::HelixClient::req_get). //! //! ```rust, no_run //! use twitch_api2::helix::{self, games::get_top_games}; //! # use twitch_api2::client; //! # #[tokio::main] //! # async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> { //! # let client: helix::HelixClient<'static, client::DummyHttpClient> = helix::HelixClient::default(); //! # let token = twitch_oauth2::AccessToken::new("validtoken".to_string()); //! # let token = twitch_oauth2::UserToken::from_existing(twitch_oauth2::dummy_http_client, token, None, None).await?; //! let request = get_top_games::GetTopGamesRequest::builder() //! .build(); //! let response: Vec<get_top_games::Game> = client.req_get(request, &token).await?.data; //! # Ok(()) //! # } //! ``` //! //! You can also get the [`http::Request`] with [`request.create_request(&token, &client_id)`](helix::RequestGet::create_request) //! and parse the [`http::Response`] with [`request.parse_response(&request.get_uri()?)`](helix::RequestGet::parse_response()) use super::*; /// Query Parameters for [Get Top Games](super::get_games) /// /// [`get-top-games`](https://dev.twitch.tv/docs/api/reference#get-top-games) #[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug)] #[non_exhaustive] pub struct GetTopGamesRequest { /// 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. #[builder(default)] pub after: Option<helix::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. #[builder(default)] pub before: Option<helix::Cursor>, /// Maximum number of objects to return. Maximum: 100. Default: 20. #[builder(default)] #[builder(setter(strip_option))] pub first: Option<usize>, } /// Return Values for [Get Top Games](super::get_games) /// /// [`get-top-games`](https://dev.twitch.tv/docs/api/reference#get-top-games) pub type Game = types::TwitchCategory; impl helix::Request for GetTopGamesRequest { type Response = Vec<Game>; const PATH: &'static str = "games/top"; #[cfg(feature = "twitch_oauth2")] const SCOPE: &'static [twitch_oauth2::Scope] = &[]; } impl helix::RequestGet for GetTopGamesRequest {} impl helix::Paginated for GetTopGamesRequest { fn set_pagination(&mut self, cursor: Option<helix::Cursor>) { self.after = cursor } } #[test] fn test_request() { use helix::*; let req = GetTopGamesRequest::builder().build(); // From twitch docs let data = br#" { "data": [ { "id": "493057", "name": "PLAYERUNKNOWN'S BATTLEGROUNDS", "box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/PLAYERUNKNOWN%27S%20BATTLEGROUNDS-{width}x{height}.jpg" }, { "id": "493057", "name": "PLAYERUNKNOWN'S BATTLEGROUNDS", "box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/PLAYERUNKNOWN%27S%20BATTLEGROUNDS-{width}x{height}.jpg" } ], "pagination":{"cursor":"eyJiIjpudWxsLCJhIjp7Ik9mZnNldCI6MjB9fQ=="} } "# .to_vec(); let http_response = http::Response::builder().body(data).unwrap(); let uri = req.get_uri().unwrap(); assert_eq!(uri.to_string(), "https://api.twitch.tv/helix/games/top?"); dbg!(GetTopGamesRequest::parse_response(Some(req), &uri, http_response).unwrap()); }