Struct twitch_api2::helix::Response

#[non_exhaustive]
pub struct Response<R, D> where
    R: Request,
    D: DeserializeOwned + PartialEq,  {
    pub data: D,
    pub pagination: Option<Cursor>,
    pub request: Option<R>,
    pub total: Option<i64>,
    pub other: Option<Map<String, Value>>,
}

Available on crate feature helix only.

Response retrieved from endpoint. Data is the type in Request::Response

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.

data: D

Twitch’s response field for data.

pagination: Option<Cursor>

A cursor value, to be used in a subsequent request to specify the starting point of the next set of results.

request: Option<R>

The request that was sent, used for pagination.

total: Option<i64>

Response would return this many results if fully paginated. Sometimes this is not emmitted or correct for this purpose, in those cases, this value will be None.

other: Option<Map<String, Value>>

Fields which are not part of the data response, but are returned by the endpoint.

See for example Get Broadcaster Subscriptions which returns this.

Implementations

impl Response<GetBroadcasterSubscriptionsRequest, Vec<BroadcasterSubscription>>

pub fn points(&self) -> Result<i64, BroadcasterSubscriptionPointsError>

The current number of subscriber points earned by this broadcaster.

impl<R, D> Response<R, D> where
    R: Request,
    D: DeserializeOwned + PartialEq, 

pub fn get_other<Q, V>(&self, key: &Q) -> Result<Option<V>, Error> where
    String: Borrow<Q>,
    Q: ?Sized + Ord + Eq + Hash,
    V: DeserializeOwned, 

Get a field from the response that is not part of data.

impl<R, D, T> Response<R, D> where
    R: Request,
    D: IntoIterator<Item = T> + PartialEq + DeserializeOwned, 

pub fn first(self) -> Option<T>

Get first result of this response.

impl<R, D> Response<R, D> where
    R: Request<Response = D> + Clone + Paginated + RequestGet + Debug,
    D: DeserializeOwned + Debug + PartialEq, 

pub async fn get_next<'a, C: HttpClient<'a>>(
    self,
    client: &'a HelixClient<'a, C>,
    token: &impl TwitchToken + ?Sized
) -> Result<Option<Response<R, D>>, ClientRequestError<<C as HttpClient<'a>>::Error>>

Available on crate feature client only.

Get the next page in the responses.

Trait Implementations

impl<R: Debug, D: Debug> Debug for Response<R, D> where
    R: Request,
    D: DeserializeOwned + PartialEq, 

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

Formats the value using the given formatter.

impl<R: PartialEq, D: PartialEq> PartialEq<Response<R, D>> for Response<R, D> where
    R: Request,
    D: DeserializeOwned + PartialEq, 

fn eq(&self, other: &Response<R, D>) -> bool

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

fn ne(&self, other: &Response<R, D>) -> bool

This method tests for !=.

impl<R, D> StructuralPartialEq for Response<R, D> where
    R: Request,
    D: DeserializeOwned + PartialEq,