pub trait Request: Serialize {
type Response: DeserializeOwned + PartialEq;
const PATH: &'static str;
const SCOPE: &'static [Scope];
const OPT_SCOPE: &'static [Scope] = _;
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.Expand description
A request is a Twitch endpoint, see New Twitch API reference
Required Associated Types
sourcetype Response: DeserializeOwned + PartialEq
type Response: DeserializeOwned + PartialEq
Response type. twitch’s response will deserialize to this.
Required Associated Constants
sourceconst PATH: &'static str
const PATH: &'static str
The path to the endpoint relative to the helix root. eg. channels
for Get Channel Information
Provided Associated Constants
Provided Methods
sourcefn query(&self) -> Result<String, SerializeError>
fn query(&self) -> Result<String, SerializeError>
Defines layout of the url parameters.
sourcefn get_uri(&self) -> Result<Uri, InvalidUri>
fn get_uri(&self) -> Result<Uri, InvalidUri>
Returns full URI for the request, including query parameters.
Examples found in repository?
src/helix/request.rs (line 54)
≺ ≻
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
fn create_request(
&self,
body: Self::Body,
token: &str,
client_id: &str,
) -> Result<http::Request<hyper::body::Bytes>, CreateRequestError> {
let uri = self.get_uri()?;
let body = body.try_to_body()?;
eprintln!("\n\nbody is ------------ {:?} ------------", body);
let mut bearer =
http::HeaderValue::from_str(&format!("Bearer {}", token)).map_err(|_| {
CreateRequestError::Custom("Could not make token into headervalue".into())
})?;
bearer.set_sensitive(true);
http::Request::builder()
.method(http::Method::POST)
.uri(uri)
.header("Client-ID", client_id)
.header("Content-Type", "application/json")
.header(http::header::AUTHORIZATION, bearer)
.body(body)
.map_err(Into::into)
}
/// Parse response.
///
/// # Notes
///
/// Pass in the request to enable [pagination](Response::get_next) if supported.
fn parse_response<B: Into<hyper::body::Bytes>>(
// FIXME: Is this really needed? Its currently only used for error reporting.
request: Option<Self>,
uri: &http::Uri,
response: http::Response<B>,
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestPostError>
where
Self: Sized,
{
let response: http::Response<hyper::body::Bytes> = response.map(|b| b.into());
let text = std::str::from_utf8(response.body().as_ref()).map_err(|e| {
HelixRequestPostError::Utf8Error(response.body().clone(), e, uri.clone())
})?;
if let Ok(HelixRequestError {
error,
status,
message,
}) = parse_json::<HelixRequestError>(text, false)
{
return Err(HelixRequestPostError::Error {
error,
status: status.try_into().unwrap_or(http::StatusCode::BAD_REQUEST),
message,
uri: uri.clone(),
body: response.body().clone(),
});
}
<Self as RequestPost>::parse_inner_response(request, uri, text, response.status())
}
/// Parse a response string into the response.
fn parse_inner_response(
request: Option<Self>,
uri: &http::Uri,
response: &str,
status: http::StatusCode,
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestPostError>
where
Self: Sized,
{
let response: InnerResponse<<Self as Request>::Response> = parse_json(response, true)
.map_err(|e| {
HelixRequestPostError::DeserializeError(
response.to_string(),
e,
uri.clone(),
status,
)
})?;
Ok(Response {
data: response.data,
pagination: response.pagination.cursor,
request,
total: response.total,
other: None,
})
}
}
/// Helix endpoint PATCHs information
pub trait RequestPatch: Request {
/// Body parameters
type Body: HelixRequestBody;
/// Create a [`http::Request`] from this [`Request`] in your client
fn create_request(
&self,
body: Self::Body,
token: &str,
client_id: &str,
) -> Result<http::Request<hyper::body::Bytes>, CreateRequestError> {
let uri = self.get_uri()?;
let body = body.try_to_body()?;
// eprintln!("\n\nbody is ------------ {} ------------", body);
let mut bearer =
http::HeaderValue::from_str(&format!("Bearer {}", token)).map_err(|_| {
CreateRequestError::Custom("Could not make token into headervalue".into())
})?;
bearer.set_sensitive(true);
http::Request::builder()
.method(http::Method::PATCH)
.uri(uri)
.header("Client-ID", client_id)
.header("Content-Type", "application/json")
.header(http::header::AUTHORIZATION, bearer)
.body(body)
.map_err(Into::into)
}
/// Parse response.
///
/// # Notes
///
/// Pass in the request to enable [pagination](Response::get_next) if supported.
fn parse_response<B: Into<hyper::body::Bytes>>(
// FIXME: Is this really needed? Its currently only used for error reporting.
request: Option<Self>,
uri: &http::Uri,
response: http::Response<B>,
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestPatchError>
where
Self: Sized,
{
let response: http::Response<hyper::body::Bytes> = response.map(|b| b.into());
let text = std::str::from_utf8(response.body().as_ref()).map_err(|e| {
HelixRequestPatchError::Utf8Error(response.body().clone(), e, uri.clone())
})?;
if let Ok(HelixRequestError {
error,
status,
message,
}) = parse_json::<HelixRequestError>(text, false)
{
return Err(HelixRequestPatchError::Error {
error,
status: status.try_into().unwrap_or(http::StatusCode::BAD_REQUEST),
message,
uri: uri.clone(),
body: response.body().clone(),
});
}
<Self as RequestPatch>::parse_inner_response(request, uri, text, response.status())
}
/// Parse a response string into the response.
fn parse_inner_response(
request: Option<Self>,
uri: &http::Uri,
response: &str,
status: http::StatusCode,
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestPatchError>
where
Self: Sized;
}
/// Helix endpoint DELETEs information
pub trait RequestDelete: Request {
/// Create a [`http::Request`] from this [`Request`] in your client
fn create_request(
&self,
token: &str,
client_id: &str,
) -> Result<http::Request<hyper::body::Bytes>, CreateRequestError> {
let uri = self.get_uri()?;
let mut bearer =
http::HeaderValue::from_str(&format!("Bearer {}", token)).map_err(|_| {
CreateRequestError::Custom("Could not make token into headervalue".into())
})?;
bearer.set_sensitive(true);
http::Request::builder()
.method(http::Method::DELETE)
.uri(uri)
.header("Client-ID", client_id)
.header("Content-Type", "application/json")
.header(http::header::AUTHORIZATION, bearer)
.body(Vec::with_capacity(0).into())
.map_err(Into::into)
}
/// Parse response.
///
/// # Notes
///
/// Pass in the request to enable [pagination](Response::get_next) if supported.
fn parse_response<B: Into<hyper::body::Bytes>>(
// FIXME: Is this really needed? Its currently only used for error reporting.
request: Option<Self>,
uri: &http::Uri,
response: http::Response<B>,
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestDeleteError>
where
Self: Sized,
{
let response: http::Response<hyper::body::Bytes> = response.map(|b| b.into());
let text = std::str::from_utf8(response.body().as_ref()).map_err(|e| {
HelixRequestDeleteError::Utf8Error(response.body().clone(), e, uri.clone())
})?;
if let Ok(HelixRequestError {
error,
status,
message,
}) = parse_json::<HelixRequestError>(text, false)
{
return Err(HelixRequestDeleteError::Error {
error,
status: status.try_into().unwrap_or(http::StatusCode::BAD_REQUEST),
message,
uri: uri.clone(),
body: response.body().clone(),
});
}
<Self as RequestDelete>::parse_inner_response(request, uri, text, response.status())
}
/// Parse a response string into the response.
fn parse_inner_response(
request: Option<Self>,
uri: &http::Uri,
response: &str,
status: http::StatusCode,
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestDeleteError>
where
Self: Sized;
}
/// Helix endpoint PUTs information
pub trait RequestPut: Request {
/// Body parameters
type Body: HelixRequestBody;
/// Create a [`http::Request`] from this [`Request`] in your client
fn create_request(
&self,
body: Self::Body,
token: &str,
client_id: &str,
) -> Result<http::Request<hyper::body::Bytes>, CreateRequestError> {
let uri = self.get_uri()?;
let body = body.try_to_body()?;
// eprintln!("\n\nbody is ------------ {} ------------", body);
let mut bearer =
http::HeaderValue::from_str(&format!("Bearer {}", token)).map_err(|_| {
CreateRequestError::Custom("Could not make token into headervalue".into())
})?;
bearer.set_sensitive(true);
http::Request::builder()
.method(http::Method::PUT)
.uri(uri)
.header("Client-ID", client_id)
.header("Content-Type", "application/json")
.header(http::header::AUTHORIZATION, bearer)
.body(body)
.map_err(Into::into)
}
/// Parse response.
///
/// # Notes
///
/// Pass in the request to enable [pagination](Response::get_next) if supported.
fn parse_response<B: Into<hyper::body::Bytes>>(
// FIXME: Is this really needed? Its currently only used for error reporting.
request: Option<Self>,
uri: &http::Uri,
response: http::Response<B>,
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestPutError>
where
Self: Sized,
{
let response: http::Response<hyper::body::Bytes> = response.map(|b| b.into());
let text = std::str::from_utf8(response.body().as_ref()).map_err(|e| {
HelixRequestPutError::Utf8Error(response.body().clone(), e, uri.clone())
})?;
if let Ok(HelixRequestError {
error,
status,
message,
}) = parse_json::<HelixRequestError>(text, false)
{
return Err(HelixRequestPutError::Error {
error,
status: status.try_into().unwrap_or(http::StatusCode::BAD_REQUEST),
message,
uri: uri.clone(),
body: response.body().clone(),
});
}
<Self as RequestPut>::parse_inner_response(request, uri, text, response.status())
}
/// Parse a response string into the response.
fn parse_inner_response(
request: Option<Self>,
uri: &http::Uri,
response: &str,
status: http::StatusCode,
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestPutError>
where
Self: Sized;
}
/// Helix endpoint GETs information
pub trait RequestGet: Request {
/// Create a [`http::Request`] from this [`Request`] in your client
fn create_request(
&self,
token: &str,
client_id: &str,
) -> Result<http::Request<hyper::body::Bytes>, CreateRequestError> {
let uri = self.get_uri()?;
let mut bearer =
http::HeaderValue::from_str(&format!("Bearer {}", token)).map_err(|_| {
CreateRequestError::Custom("Could not make token into headervalue".into())
})?;
bearer.set_sensitive(true);
http::Request::builder()
.method(http::Method::GET)
.uri(uri)
.header("Client-ID", client_id)
.header("Content-Type", "application/json")
.header(http::header::AUTHORIZATION, bearer)
.body(Vec::with_capacity(0).into())
.map_err(Into::into)
}
sourcefn get_bare_uri() -> Result<Uri, InvalidUri>
fn get_bare_uri() -> Result<Uri, InvalidUri>
Returns bare URI for the request, NOT including query parameters.
Implementors
sourceimpl Request for GetBitsLeaderboardRequest<'_>
impl Request for GetBitsLeaderboardRequest<'_>
sourceimpl Request for GetCheermotesRequest<'_>
impl Request for GetCheermotesRequest<'_>
sourceimpl Request for AddChannelVipRequest<'_>
impl Request for AddChannelVipRequest<'_>
sourceimpl Request for GetChannelEditorsRequest<'_>
impl Request for GetChannelEditorsRequest<'_>
sourceimpl Request for GetChannelInformationRequest<'_>
impl Request for GetChannelInformationRequest<'_>
sourceimpl Request for GetVipsRequest<'_>
impl Request for GetVipsRequest<'_>
sourceimpl Request for ModifyChannelInformationRequest<'_>
impl Request for ModifyChannelInformationRequest<'_>
sourceimpl Request for RemoveChannelVipRequest<'_>
impl Request for RemoveChannelVipRequest<'_>
sourceimpl Request for StartCommercialRequest<'_>
impl Request for StartCommercialRequest<'_>
sourceimpl Request for GetChannelChatBadgesRequest<'_>
impl Request for GetChannelChatBadgesRequest<'_>
sourceimpl Request for GetChannelEmotesRequest<'_>
impl Request for GetChannelEmotesRequest<'_>
sourceimpl Request for GetChatSettingsRequest<'_>
impl Request for GetChatSettingsRequest<'_>
sourceimpl Request for GetChattersRequest<'_>
impl Request for GetChattersRequest<'_>
sourceimpl Request for GetEmoteSetsRequest<'_>
impl Request for GetEmoteSetsRequest<'_>
sourceimpl Request for GetGlobalChatBadgesRequest
impl Request for GetGlobalChatBadgesRequest
sourceimpl Request for GetGlobalEmotesRequest
impl Request for GetGlobalEmotesRequest
sourceimpl Request for GetUserChatColorRequest<'_>
impl Request for GetUserChatColorRequest<'_>
sourceimpl Request for SendChatAnnouncementRequest<'_>
impl Request for SendChatAnnouncementRequest<'_>
sourceimpl Request for UpdateChatSettingsRequest<'_>
impl Request for UpdateChatSettingsRequest<'_>
sourceimpl Request for UpdateUserChatColorRequest<'_>
impl Request for UpdateUserChatColorRequest<'_>
sourceimpl Request for GetClipsRequest<'_>
impl Request for GetClipsRequest<'_>
sourceimpl Request for DeleteEventSubSubscriptionRequest<'_>
Available on crate feature eventsub
only.
impl Request for DeleteEventSubSubscriptionRequest<'_>
Available on crate feature
eventsub
only.sourceimpl Request for GetEventSubSubscriptionsRequest<'_>
Available on crate feature eventsub
only.
impl Request for GetEventSubSubscriptionsRequest<'_>
Available on crate feature
eventsub
only.sourceimpl Request for GetGamesRequest<'_>
impl Request for GetGamesRequest<'_>
sourceimpl Request for GetTopGamesRequest<'_>
impl Request for GetTopGamesRequest<'_>
sourceimpl Request for GetCreatorGoalsRequest<'_>
impl Request for GetCreatorGoalsRequest<'_>
sourceimpl Request for GetHypeTrainEventsRequest<'_>
impl Request for GetHypeTrainEventsRequest<'_>
sourceimpl Request for AddBlockedTermRequest<'_>
impl Request for AddBlockedTermRequest<'_>
sourceimpl Request for AddChannelModeratorRequest<'_>
impl Request for AddChannelModeratorRequest<'_>
sourceimpl Request for BanUserRequest<'_>
impl Request for BanUserRequest<'_>
sourceimpl Request for CheckAutoModStatusRequest<'_>
impl Request for CheckAutoModStatusRequest<'_>
sourceimpl Request for DeleteChatMessagesRequest<'_>
impl Request for DeleteChatMessagesRequest<'_>
sourceimpl Request for GetBannedUsersRequest<'_>
impl Request for GetBannedUsersRequest<'_>
sourceimpl Request for GetBlockedTerms<'_>
impl Request for GetBlockedTerms<'_>
sourceimpl Request for GetModeratorsRequest<'_>
impl Request for GetModeratorsRequest<'_>
sourceimpl Request for ManageHeldAutoModMessagesRequest<'_>
impl Request for ManageHeldAutoModMessagesRequest<'_>
sourceimpl Request for RemoveBlockedTermRequest<'_>
impl Request for RemoveBlockedTermRequest<'_>
sourceimpl Request for RemoveChannelModeratorRequest<'_>
impl Request for RemoveChannelModeratorRequest<'_>
sourceimpl Request for UnbanUserRequest<'_>
impl Request for UnbanUserRequest<'_>
sourceimpl Request for CreateCustomRewardRequest<'_>
impl Request for CreateCustomRewardRequest<'_>
sourceimpl Request for DeleteCustomRewardRequest<'_>
impl Request for DeleteCustomRewardRequest<'_>
sourceimpl Request for GetCustomRewardRequest<'_>
impl Request for GetCustomRewardRequest<'_>
sourceimpl Request for GetCustomRewardRedemptionRequest<'_>
impl Request for GetCustomRewardRedemptionRequest<'_>
sourceimpl Request for UpdateCustomRewardRequest<'_>
impl Request for UpdateCustomRewardRequest<'_>
sourceimpl Request for UpdateRedemptionStatusRequest<'_>
impl Request for UpdateRedemptionStatusRequest<'_>
sourceimpl Request for CreatePollRequest<'_>
impl Request for CreatePollRequest<'_>
sourceimpl Request for EndPollRequest<'_>
impl Request for EndPollRequest<'_>
sourceimpl Request for GetPollsRequest<'_>
impl Request for GetPollsRequest<'_>
sourceimpl Request for CreatePredictionRequest<'_>
impl Request for CreatePredictionRequest<'_>
sourceimpl Request for EndPredictionRequest<'_>
impl Request for EndPredictionRequest<'_>
sourceimpl Request for GetPredictionsRequest<'_>
impl Request for GetPredictionsRequest<'_>
sourceimpl Request for CancelARaidRequest<'_>
impl Request for CancelARaidRequest<'_>
sourceimpl Request for StartARaidRequest<'_>
impl Request for StartARaidRequest<'_>
sourceimpl Request for CreateChannelStreamScheduleSegmentRequest<'_>
impl Request for CreateChannelStreamScheduleSegmentRequest<'_>
sourceimpl Request for DeleteChannelStreamScheduleSegmentRequest<'_>
impl Request for DeleteChannelStreamScheduleSegmentRequest<'_>
sourceimpl Request for GetChannelStreamScheduleRequest<'_>
impl Request for GetChannelStreamScheduleRequest<'_>
sourceimpl Request for UpdateChannelStreamScheduleRequest<'_>
impl Request for UpdateChannelStreamScheduleRequest<'_>
sourceimpl Request for UpdateChannelStreamScheduleSegmentRequest<'_>
impl Request for UpdateChannelStreamScheduleSegmentRequest<'_>
sourceimpl Request for SearchCategoriesRequest<'_>
impl Request for SearchCategoriesRequest<'_>
sourceimpl Request for SearchChannelsRequest<'_>
impl Request for SearchChannelsRequest<'_>
sourceimpl Request for GetFollowedStreamsRequest<'_>
impl Request for GetFollowedStreamsRequest<'_>
sourceimpl Request for GetStreamTagsRequest<'_>
impl Request for GetStreamTagsRequest<'_>
sourceimpl Request for GetStreamsRequest<'_>
impl Request for GetStreamsRequest<'_>
sourceimpl Request for ReplaceStreamTagsRequest<'_>
impl Request for ReplaceStreamTagsRequest<'_>
sourceimpl Request for CheckUserSubscriptionRequest<'_>
impl Request for CheckUserSubscriptionRequest<'_>
sourceimpl Request for GetBroadcasterSubscriptionsRequest<'_>
impl Request for GetBroadcasterSubscriptionsRequest<'_>
sourceimpl Request for GetBroadcasterSubscriptionsEventsRequest<'_>
impl Request for GetBroadcasterSubscriptionsEventsRequest<'_>
sourceimpl Request for GetAllStreamTagsRequest<'_>
impl Request for GetAllStreamTagsRequest<'_>
sourceimpl Request for GetChannelTeamsRequest<'_>
impl Request for GetChannelTeamsRequest<'_>
sourceimpl Request for GetTeamsRequest<'_>
impl Request for GetTeamsRequest<'_>
sourceimpl Request for BlockUserRequest<'_>
impl Request for BlockUserRequest<'_>
sourceimpl Request for GetUserBlockListRequest<'_>
impl Request for GetUserBlockListRequest<'_>
sourceimpl Request for GetUsersRequest<'_>
impl Request for GetUsersRequest<'_>
sourceimpl Request for GetUsersFollowsRequest<'_>
impl Request for GetUsersFollowsRequest<'_>
sourceimpl Request for UnblockUserRequest<'_>
impl Request for UnblockUserRequest<'_>
sourceimpl Request for DeleteVideosRequest<'_>
impl Request for DeleteVideosRequest<'_>
sourceimpl Request for GetVideosRequest<'_>
impl Request for GetVideosRequest<'_>
sourceimpl Request for SendWhisperRequest<'_>
impl Request for SendWhisperRequest<'_>
sourceimpl<E: EventSubscription> Request for CreateEventSubSubscriptionRequest<E>
Available on crate feature eventsub
only.
impl<E: EventSubscription> Request for CreateEventSubSubscriptionRequest<E>
Available on crate feature
eventsub
only.