Trait twitch_api2::helix::Request

pub trait Request: Serialize {
    type Response;

    const PATH: &'static str;
    const SCOPE: &'static [Scope];
    const OPT_SCOPE: &'static [Scope];
    fn query(&self) -> Result<String, Error> { ... }
}

A request is a Twitch endpoint, see New Twitch API reference

Associated Types

type Response

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

Loading content...

Associated Constants

const PATH: &'static str

The path to the endpoint relative to the helix root. eg. channels for Get Channel Information

const SCOPE: &'static [Scope]

Scopes needed by this endpoint

const OPT_SCOPE: &'static [Scope]

Optional scopes needed by this endpoint

Loading content...

Provided methods

fn query(&self) -> Result<String, Error>

Defines layout of the url parameters.

Loading content...

Implementors

impl Request for GetChannelInformationRequest

type Response = GetChannelInformation

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for ModifyChannelInformationRequest

type Response = ModifyChannelInformation

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for StartCommercialRequest

type Response = StartCommercial

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetClipsRequest

type Response = GetClips

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for CheckAutoModStatusRequest

type Response = CheckAutoModStatus

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetBannedEventsRequest

type Response = GetBannedEvents

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetBannedUsersRequest

type Response = GetBannedUsers

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetModeratorEventsRequest

type Response = GetModeratorEvents

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetModeratorsRequest

type Response = GetModerators

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetStreamsRequest

type Response = GetStreams

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetBroadcasterSubscriptionsRequest

type Response = GetBroadcasterSubscriptions

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetUsersRequest

type Response = GetUsers

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str

const SCOPE: &'static [Scope]

Loading content...