Trait Request

pub trait Request: Serialize {
    type Response: DeserializeOwned + PartialEq;

    const PATH: &'static str;
    const SCOPE: &'static [Scope];
    const OPT_SCOPE: &'static [Scope] = _;

    // Provided methods
    fn query(&self) -> Result<String, SerializeError> { ... }
    fn get_uri(&self) -> Result<Uri, InvalidUri> { ... }
    fn get_bare_uri() -> Result<Uri, InvalidUri> { ... }
}

Available on crate feature helix only.

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

Required 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]

Available on crate feature twitch_oauth2 only.

Scopes needed by this endpoint

Provided Associated Constants

const OPT_SCOPE: &'static [Scope] = _

Available on crate feature twitch_oauth2 only.

Optional scopes needed by this endpoint

Required Associated Types

type Response: DeserializeOwned + PartialEq

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

Provided Methods

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

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.

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 GetBitsLeaderboardRequest

const PATH: &'static str = "bits/leaderboard"

const SCOPE: &'static [Scope]

type Response = BitsLeaderboard

impl Request for GetCheermotesRequest

const PATH: &'static str = "bits/cheermotes"

const SCOPE: &'static [Scope]

type Response = Vec<Cheermote>

impl Request for GetChannelEditorsRequest

const PATH: &'static str = "channels/editors"

const SCOPE: &'static [Scope]

type Response = Vec<Editor>

impl Request for GetChannelInformationRequest

const PATH: &'static str = "channels"

const SCOPE: &'static [Scope]

type Response = Option<ChannelInformation>

impl Request for ModifyChannelInformationRequest

const PATH: &'static str = "channels"

const SCOPE: &'static [Scope]

type Response = ModifyChannelInformation

impl Request for StartCommercialRequest

const PATH: &'static str = "channels/commercial"

const SCOPE: &'static [Scope]

type Response = Vec<StartCommercial>

impl Request for GetChannelChatBadgesRequest

const PATH: &'static str = "chat/badges"

const SCOPE: &'static [Scope]

type Response = Vec<BadgeSet>

impl Request for GetChannelEmotesRequest

const PATH: &'static str = "chat/emotes"

const SCOPE: &'static [Scope]

type Response = Vec<ChannelEmote>

impl Request for GetEmoteSetsRequest

const PATH: &'static str = "chat/emotes/set"

const SCOPE: &'static [Scope]

type Response = Vec<Emote>

impl Request for GetGlobalChatBadgesRequest

const PATH: &'static str = "chat/badges/global"

const SCOPE: &'static [Scope]

type Response = Vec<BadgeSet>

impl Request for GetGlobalEmotesRequest

const PATH: &'static str = "chat/emotes/global"

const SCOPE: &'static [Scope]

type Response = Vec<GlobalEmote>

impl Request for UpdateChatSettingsRequest

const PATH: &'static str = "chat/settings"

const SCOPE: &'static [Scope]

type Response = ChatSettings

impl Request for GetClipsRequest

const PATH: &'static str = "clips"

const SCOPE: &'static [Scope]

type Response = Vec<Clip>

impl Request for DeleteEventSubSubscriptionRequest

Available on crate feature eventsub only.

const PATH: &'static str = "eventsub/subscriptions"

const SCOPE: &'static [Scope]

type Response = DeleteEventSubSubscription

impl Request for GetEventSubSubscriptionsRequest

Available on crate feature eventsub only.

const PATH: &'static str = "eventsub/subscriptions"

const SCOPE: &'static [Scope]

type Response = EventSubSubscriptions

impl Request for GetGamesRequest

const PATH: &'static str = "games"

const SCOPE: &'static [Scope]

type Response = Vec<TwitchCategory>

impl Request for GetTopGamesRequest

const PATH: &'static str = "games/top"

const SCOPE: &'static [Scope]

type Response = Vec<TwitchCategory>

impl Request for GetCreatorGoalsRequest

const PATH: &'static str = "goals"

const SCOPE: &'static [Scope]

type Response = Vec<CreatorGoal>

impl Request for GetHypeTrainEventsRequest

const PATH: &'static str = "hypetrain/events"

const SCOPE: &'static [Scope]

type Response = Vec<HypeTrainEvent>

impl Request for GetBlockedTerms

const PATH: &'static str = "moderation/blocked_terms"

const SCOPE: &'static [Scope]

type Response = Vec<BlockedTerm>

impl Request for AddBlockedTermRequest

const PATH: &'static str = "moderation/blocked_terms"

const SCOPE: &'static [Scope]

type Response = Vec<BlockedTerm>

impl Request for BanUserRequest

const PATH: &'static str = "moderation/bans"

const SCOPE: &'static [Scope]

type Response = BanUser

impl Request for CheckAutoModStatusRequest

const PATH: &'static str = "moderation/enforcements/status"

const SCOPE: &'static [Scope]

type Response = Vec<CheckAutoModStatus>

impl Request for GetBannedUsersRequest

const PATH: &'static str = "moderation/banned"

const SCOPE: &'static [Scope]

type Response = Vec<BannedUser>

impl Request for GetModeratorsRequest

const PATH: &'static str = "moderation/moderators"

const SCOPE: &'static [Scope]

type Response = Vec<Moderator>

impl Request for ManageHeldAutoModMessagesRequest

const PATH: &'static str = "moderation/automod/message"

const SCOPE: &'static [Scope]

type Response = ManageHeldAutoModMessages

impl Request for RemoveBlockedTermRequest

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str = "moderation/blocked_terms"

const SCOPE: &'static [Scope]

type Response = RemoveBlockedTerm

impl Request for UnbanUserRequest

const PATH: &'static str = "moderation/bans"

const SCOPE: &'static [Scope]

type Response = UnbanUserResponse

impl Request for CreateCustomRewardRequest

const PATH: &'static str = "channel_points/custom_rewards"

const SCOPE: &'static [Scope]

type Response = CustomReward

impl Request for DeleteCustomRewardRequest

const PATH: &'static str = "channel_points/custom_rewards"

const SCOPE: &'static [Scope]

type Response = DeleteCustomReward

impl Request for GetCustomRewardRedemptionRequest

const PATH: &'static str = "channel_points/custom_rewards/redemptions"

const SCOPE: &'static [Scope]

type Response = Vec<CustomRewardRedemption>

impl Request for GetCustomRewardRequest

const PATH: &'static str = "channel_points/custom_rewards"

const SCOPE: &'static [Scope]

type Response = Vec<CustomReward>

impl Request for UpdateCustomRewardRequest

const PATH: &'static str = "channel_points/custom_rewards"

const SCOPE: &'static [Scope]

type Response = UpdateCustomReward

impl Request for UpdateRedemptionStatusRequest

const PATH: &'static str = "channel_points/custom_rewards/redemptions"

const SCOPE: &'static [Scope]

type Response = UpdateRedemptionStatusInformation

impl Request for CreatePollRequest

const PATH: &'static str = "polls"

const SCOPE: &'static [Scope]

type Response = Poll

impl Request for EndPollRequest

const PATH: &'static str = "polls"

const SCOPE: &'static [Scope]

type Response = EndPoll

impl Request for GetPollsRequest

const PATH: &'static str = "polls"

const SCOPE: &'static [Scope]

type Response = Vec<Poll>

impl Request for CreatePredictionRequest

const PATH: &'static str = "predictions"

const SCOPE: &'static [Scope]

type Response = Prediction

impl Request for EndPredictionRequest

const PATH: &'static str = "predictions"

const SCOPE: &'static [Scope]

type Response = EndPrediction

impl Request for GetPredictionsRequest

const PATH: &'static str = "predictions"

const SCOPE: &'static [Scope]

type Response = Vec<Prediction>

impl Request for CreateChannelStreamScheduleSegmentRequest

const PATH: &'static str = "schedule/segment"

const SCOPE: &'static [Scope]

type Response = ScheduledBroadcasts

impl Request for GetChannelStreamScheduleRequest

const PATH: &'static str = "schedule"

const SCOPE: &'static [Scope]

type Response = ScheduledBroadcasts

impl Request for UpdateChannelStreamScheduleRequest

const PATH: &'static str = "schedule/settings"

const SCOPE: &'static [Scope]

type Response = UpdateChannelStreamSchedule

impl Request for UpdateChannelStreamScheduleSegmentRequest

const PATH: &'static str = "schedule/segment"

const SCOPE: &'static [Scope]

type Response = ScheduledBroadcasts

impl Request for SearchCategoriesRequest

const PATH: &'static str = "search/categories"

const SCOPE: &'static [Scope]

type Response = Vec<TwitchCategory>

impl Request for SearchChannelsRequest

const PATH: &'static str = "search/channels"

const SCOPE: &'static [Scope]

type Response = Vec<Channel>

impl Request for GetFollowedStreamsRequest

const PATH: &'static str = "streams/followed"

const SCOPE: &'static [Scope]

type Response = Vec<Stream>

impl Request for GetStreamTagsRequest

const PATH: &'static str = "streams/tags"

const SCOPE: &'static [Scope]

type Response = Vec<TwitchTag>

impl Request for GetStreamsRequest

const PATH: &'static str = "streams"

const SCOPE: &'static [Scope]

type Response = Vec<Stream>

impl Request for ReplaceStreamTagsRequest

const PATH: &'static str = "streams/tags"

const SCOPE: &'static [Scope]

type Response = ReplaceStreamTags

impl Request for CheckUserSubscriptionRequest

const PATH: &'static str = "subscriptions/user"

const SCOPE: &'static [Scope]

type Response = UserSubscription

impl Request for GetBroadcasterSubscriptionsEventsRequest

const PATH: &'static str = "subscriptions/events"

const SCOPE: &'static [Scope]

type Response = Vec<BroadcasterSubscriptionEvent>

impl Request for GetBroadcasterSubscriptionsRequest

const PATH: &'static str = "subscriptions"

const SCOPE: &'static [Scope]

type Response = Vec<BroadcasterSubscription>

impl Request for GetAllStreamTagsRequest

const PATH: &'static str = "tags/streams"

const SCOPE: &'static [Scope]

type Response = Vec<TwitchTag>

impl Request for GetChannelTeamsRequest

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str = "teams/channel"

const SCOPE: &'static [Scope]

type Response = Vec<BroadcasterTeam>

impl Request for GetTeamsRequest

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str = "teams"

const SCOPE: &'static [Scope]

type Response = Vec<Team>

impl Request for BlockUserRequest

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str = "users/blocks"

const SCOPE: &'static [Scope]

type Response = BlockUser

impl Request for GetUserBlockListRequest

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str = "users/blocks"

const SCOPE: &'static [Scope]

type Response = Vec<UserBlock>

impl Request for GetUsersFollowsRequest

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str = "users/follows"

const SCOPE: &'static [Scope]

type Response = UsersFollows

impl Request for GetUsersRequest

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str = "users"

const SCOPE: &'static [Scope]

type Response = Vec<User>

impl Request for UnblockUserRequest

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str = "users/blocks"

const SCOPE: &'static [Scope]

type Response = UnblockUser

impl Request for DeleteVideosRequest

const PATH: &'static str = "videos"

const SCOPE: &'static [Scope]

type Response = DeleteVideo

impl Request for GetVideosRequest

const PATH: &'static str = "videos"

const SCOPE: &'static [Scope]

type Response = Vec<Video>

impl<E: EventSubscription> Request for CreateEventSubSubscriptionRequest<E>

Available on crate feature eventsub only.

const PATH: &'static str = "eventsub/subscriptions"

const SCOPE: &'static [Scope]

type Response = CreateEventSubSubscription<E>