Trait Request 

pub trait Request {
    type Headers: Headers;
    type Parameters: Parameters;
    type Body: Body;
    type Response: Response + 'static;
    type ErrorCodes: ErrorCodes + 'static;

    const ENDPOINT: &'static str;
    const METHOD: Method;

    // Required methods
    fn builder() -> Self;
    fn headers(&self) -> &Self::Headers;
    fn parameters(&self) -> &Self::Parameters;
    fn body(&self) -> &Self::Body;
    fn ready(&self) -> Result<(), RequestError<Self::ErrorCodes>>;

    // Provided method
    fn make_request<'life0, 'async_trait, C>(
        &'life0 self,
        client: C,
    ) -> Pin<Box<dyn Future<Output = Result<Self::Response, RequestError<Self::ErrorCodes>>> + Send + 'async_trait>>
       where C: Borrow<Client> + Send + 'async_trait,
             Self: Sync + 'async_trait,
             'life0: 'async_trait { ... }
}

Represents a request that can be made to the twitch api

Required Associated Constants

const ENDPOINT: &'static str

Endpoint where the request is made

const METHOD: Method

The method that this request will use

Required Associated Types

type Headers: Headers

The type that represents the headers sent with this request

type Parameters: Parameters

The type that represents the query parameters sent with this request

type Body: Body

The type that represents the body of this request

type Response: Response + 'static

The type returned by a sucessful request, must be DeserializeOwned and have at least a static lifetime (owned).

type ErrorCodes: ErrorCodes + 'static

The type that encapsulates the error codes that this endpoint can return, must have at least a static lifetime (owned).

Required Methods

fn builder() -> Self

Get a builder for this method

fn headers(&self) -> &Self::Headers

Get the Headers struct for this Request

Will only be called when Self::ready returns Ok(()) and may not fail in that case

fn parameters(&self) -> &Self::Parameters

Get the Parameters struct for this Request

Will only be called when Self::ready returns Ok(()) and may not fail in that case

fn body(&self) -> &Self::Body

Get the Body struct for this Request

Will only be called when Self::ready returns Ok(()) and may not fail in that case

fn ready(&self) -> Result<(), RequestError<Self::ErrorCodes>>

Must return Ok(()) if and only if this request is ready to have Self::make_request called on it.

Should return RequestError::MalformedRequest with a message in the case that the request is not ready to be sent.

Called by Self::make_request, error is propogated.

Provided Methods

fn make_request<'life0, 'async_trait, C>( &'life0 self, client: C, ) -> Pin<Box<dyn Future<Output = Result<Self::Response, RequestError<Self::ErrorCodes>>> + Send + 'async_trait>>

where C: Borrow<Client> + Send + 'async_trait, Self: Sync + 'async_trait, 'life0: 'async_trait,

Make the request represented by this object. Only makes request if Self::ready returns Ok(()).

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Request for ClientAuthRequest

const ENDPOINT: &'static str = "https://id.twitch.tv/oauth2/token"

const METHOD: Method = reqwest::Method::POST

type Headers = ()

type Parameters = ClientAuthRequestParams

type Body = ()

type Response = ClientAuthResponse

type ErrorCodes = CommonResponseCodes

impl<A> Request for GetChannelInformationRequest<A>

where A: AuthToken + Sync,

const ENDPOINT: &'static str = "https://api.twitch.tv/helix/channels"

const METHOD: Method = reqwest::Method::GET

type Headers = A

type Parameters = GetChannelInformationRequest<A>

type Body = ()

type Response = GetChannelInformationResponse

type ErrorCodes = CommonResponseCodes

impl<A> Request for GetClipsRequest<A>

where A: AuthToken + Sync,

const ENDPOINT: &'static str = "https://api.twitch.tv/helix/clips"

const METHOD: Method = reqwest::Method::GET

type Headers = A

type Parameters = GetClipsRequest<A>

type Body = ()

type Response = GetClipsResponse

type ErrorCodes = CommonResponseCodes

impl<A> Request for GetUsersRequest<A>

where A: AuthToken + Send,

const ENDPOINT: &'static str = "https://api.twitch.tv/helix/users"

const METHOD: Method = reqwest::Method::GET

type Headers = A

type Parameters = GetUsersRequest<A>

type Body = ()

type Response = GetUsersResponse

type ErrorCodes = CommonResponseCodes