Trait twitch_api2::helix::webhooks::topics::Topic

pub trait Topic: DeserializeOwned + Serialize + PartialEq {
    type Helix: RequestGet + Request;

    const PATH: &'static str;
    const SCOPE: &'static [Scope];
    const OPT_SCOPE: &'static [Scope];
    fn query(&self) -> Result<String, Error> { ... }
    fn get_uri(&self) -> Result<Uri, InvalidUri> { ... }
    fn get_bare_uri() -> Result<Uri, InvalidUri> { ... }
    fn parse_payload(
        response: Response<Vec<u8>>
    ) -> Result<Response<Self::Helix, <Self::Helix as Request>::Response>, HelixRequestGetError>
    where
        Self: Sized,
    { ... }
}

This is supported on crate feature helix only.

A webhook topic.

Associated Types

type Helix: RequestGet + Request

Helix response

Loading content...

Associated Constants

const PATH: &'static str

URL of topic sans https://api.twitch.tv/helix/

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.

fn get_uri(&self) -> Result<Uri, InvalidUri>

Returns full URI for the request, including query parameters.

fn get_bare_uri() -> Result<Uri, InvalidUri>

Returns bare URI for the request, NOT including query parameters.

fn parse_payload(
    response: Response<Vec<u8>>
) -> Result<Response<Self::Helix, <Self::Helix as Request>::Response>, HelixRequestGetError> where
    Self: Sized, 

Parse payload received on webhook.

Forwards to RequestGet::parse_response

Loading content...

Implementors

impl Topic for HypeTrainEventTopic

type Helix = GetHypeTrainEventsRequest

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Topic for ChannelBanChangeEventsTopic

type Helix = GetBannedEventsRequest

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Topic for ModeratorChangedTopic

type Helix = GetModeratorEventsRequest

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Topic for StreamChangedTopic

type Helix = GetStreamsRequest

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Topic for SubscriptionEventsTopic

type Helix = GetBroadcasterSubscriptionsEventsRequest

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Topic for UserChangedTopic

type Helix = GetUsersRequest

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Topic for UserFollowsTopic

type Helix = GetUsersFollowsRequest

const PATH: &'static str

const SCOPE: &'static [Scope]

Loading content...