Merge pull request #503 from twitch-rs/refactor/req-in-response

refactor: Only include pagination data for paginated requests

Author: Emilgardis

CHANGELOG.md

@@ -8,6 +8,7 @@
 
 - Removed surf dependency and related feature flags
 - Removed http-types dependency
+- The pagination state for helix requests was moved into a separate field (`pagination_data`). The type for this depends on the `Request`. Paginatable requests will use `PaginationState<Self>` while others will use `()`.
 
 [Commits](https://github.com/twitch-rs/twitch_api/compare/v0.7.2...Unreleased)
 

src/helix/client/client_ext.rs

@@ -782,7 +782,7 @@ impl<'client, C: crate::HttpClient + Sync + 'client> HelixClient<'client, C> {
             )
             .await?;
 
-        Ok(resp.total.unwrap_or(0))
+        Ok(resp.pagination_data.total.unwrap_or(0))
     }
 
     /// Get users followed channels

src/helix/endpoints/bits/get_bits_leaderboard.rs

@@ -176,6 +176,7 @@ pub struct LeaderboardUser {
 }
 
 impl Request for GetBitsLeaderboardRequest<'_> {
+    type PaginationData = ();
     type Response = BitsLeaderboard;
 
     const PATH: &'static str = "bits/leaderboard";
@@ -186,7 +187,7 @@ impl Request for GetBitsLeaderboardRequest<'_> {
 
 impl RequestGet for GetBitsLeaderboardRequest<'_> {
     fn parse_inner_response(
-        request: Option<Self>,
+        _request: Option<Self>,
         uri: &http::Uri,
         response: &str,
         status: http::StatusCode,
@@ -215,9 +216,7 @@ impl RequestGet for GetBitsLeaderboardRequest<'_> {
                 date_range: response.date_range,
                 total: response.total,
             },
-            None,
-            request,
-            Some(response.total),
+            (),
             None,
         ))
     }

src/helix/endpoints/bits/get_cheermotes.rs

@@ -186,6 +186,7 @@ pub struct CheermoteImageArray {
 pub struct Level(pub String);
 
 impl Request for GetCheermotesRequest<'_> {
+    type PaginationData = ();
     type Response = Vec<Cheermote>;
 
     const PATH: &'static str = "bits/cheermotes";

src/helix/endpoints/ccls/get_content_classification_labels.rs

@@ -82,6 +82,7 @@ pub struct ContentClassificationLabel {
 }
 
 impl Request for GetContentClassificationLabelsRequest<'_> {
+    type PaginationData = ();
     type Response = Vec<ContentClassificationLabel>;
 
     const PATH: &'static str = "content_classification_labels";

src/helix/endpoints/channels/add_channel_vip.rs

@@ -85,6 +85,7 @@ pub enum AddChannelVipResponse {
 }
 
 impl Request for AddChannelVipRequest<'_> {
+    type PaginationData = ();
     type Response = AddChannelVipResponse;
 
     const PATH: &'static str = "channels/vips";

src/helix/endpoints/channels/get_ad_schedule.rs

@@ -98,6 +98,7 @@ pub struct AdSchedule {
 }
 
 impl Request for GetAdScheduleRequest<'_> {
+    type PaginationData = ();
     type Response = Option<AdSchedule>;
 
     const PATH: &'static str = "channels/ads";
@@ -110,7 +111,7 @@ impl Request for GetAdScheduleRequest<'_> {
 
 impl RequestGet for GetAdScheduleRequest<'_> {
     fn parse_inner_response(
-        request: Option<Self>,
+        _request: Option<Self>,
         uri: &http::Uri,
         str_response: &str,
         status: http::StatusCode,
@@ -159,9 +160,7 @@ impl RequestGet for GetAdScheduleRequest<'_> {
         };
         Ok(helix::Response::new(
             response.data.into_iter().next(),
-            response.pagination.cursor,
-            request,
-            response.total,
+            (),
             response.other,
         ))
     }

src/helix/endpoints/channels/get_channel_editors.rs

@@ -84,6 +84,7 @@ pub struct Editor {
 }
 
 impl Request for GetChannelEditorsRequest<'_> {
+    type PaginationData = ();
     type Response = Vec<Editor>;
 
     const PATH: &'static str = "channels/editors";

src/helix/endpoints/channels/get_channel_followers.rs

@@ -38,6 +38,8 @@
 //!
 //! You can also get the [`http::Request`] with [`request.create_request(&token, &client_id)`](helix::RequestGet::create_request)
 //! and parse the [`http::Response`] with [`GetChannelFollowersRequest::parse_response(None, &request.get_uri(), response)`](GetChannelFollowersRequest::parse_response)
+use crate::helix::PaginationState;
+
 use super::*;
 use helix::RequestGet;
 
@@ -119,6 +121,7 @@ pub struct Follower {
 }
 
 impl Request for GetChannelFollowersRequest<'_> {
+    type PaginationData = PaginationState<Self>;
     type Response = Vec<Follower>;
 
     const PATH: &'static str = "channels/followers";

src/helix/endpoints/channels/get_channel_information.rs

@@ -119,6 +119,7 @@ pub struct ChannelInformation {
 }
 
 impl Request for GetChannelInformationRequest<'_> {
+    type PaginationData = ();
     type Response = Vec<ChannelInformation>;
 
     const PATH: &'static str = "channels";