#[non_exhaustive]pub struct GetHypeTrainEventsRequest<'a> {
pub broadcaster_id: Cow<'a, UserIdRef>,
pub cursor: Option<Cursor>,
pub first: Option<usize>,
pub id: Option<Cow<'a, str>>,
}
Available on crate feature
helix
only.Expand description
Query Parameters for Get Hype Train Events
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.broadcaster_id: Cow<'a, UserIdRef>
Must match the User ID in the Bearer token.
cursor: Option<Cursor>
Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
first: Option<usize>
Maximum number of objects to return. Maximum: 100. Default: 20.
id: Option<Cow<'a, str>>
👎Deprecated since 0.6.0: this does nothing, see https://discuss.dev.twitch.tv/t/get-hype-train-events-api-endpoint-id-query-parameter-deprecation/37613
Retreive a single event by event ID
Implementations
sourceimpl<'a> GetHypeTrainEventsRequest<'a>
impl<'a> GetHypeTrainEventsRequest<'a>
sourcepub fn builder() -> GetHypeTrainEventsRequestBuilder<'a, ((), (), (), ())>
pub fn builder() -> GetHypeTrainEventsRequestBuilder<'a, ((), (), (), ())>
Create a builder for building GetHypeTrainEventsRequest
.
On the builder, call .broadcaster_id(...)
, .cursor(...)
(optional), .first(...)
(optional), .id(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of GetHypeTrainEventsRequest
.
sourceimpl<'a> GetHypeTrainEventsRequest<'a>
impl<'a> GetHypeTrainEventsRequest<'a>
sourcepub fn broadcaster_id(broadcaster_id: impl IntoCow<'a, UserIdRef> + 'a) -> Self
pub fn broadcaster_id(broadcaster_id: impl IntoCow<'a, UserIdRef> + 'a) -> Self
Get hypetrain evens
Trait Implementations
sourceimpl<'a> Clone for GetHypeTrainEventsRequest<'a>
impl<'a> Clone for GetHypeTrainEventsRequest<'a>
sourcefn clone(&self) -> GetHypeTrainEventsRequest<'a>
fn clone(&self) -> GetHypeTrainEventsRequest<'a>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresourceimpl<'a> Debug for GetHypeTrainEventsRequest<'a>
impl<'a> Debug for GetHypeTrainEventsRequest<'a>
sourceimpl<'de: 'a, 'a> Deserialize<'de> for GetHypeTrainEventsRequest<'a>
impl<'de: 'a, 'a> Deserialize<'de> for GetHypeTrainEventsRequest<'a>
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Paginated for GetHypeTrainEventsRequest<'_>
impl Paginated for GetHypeTrainEventsRequest<'_>
sourcefn set_pagination(&mut self, cursor: Option<Cursor>)
fn set_pagination(&mut self, cursor: Option<Cursor>)
Should returns the current pagination cursor. Read more
sourceimpl<'a> PartialEq<GetHypeTrainEventsRequest<'a>> for GetHypeTrainEventsRequest<'a>
impl<'a> PartialEq<GetHypeTrainEventsRequest<'a>> for GetHypeTrainEventsRequest<'a>
sourcefn eq(&self, other: &GetHypeTrainEventsRequest<'a>) -> bool
fn eq(&self, other: &GetHypeTrainEventsRequest<'a>) -> bool
sourceimpl Request for GetHypeTrainEventsRequest<'_>
impl Request for GetHypeTrainEventsRequest<'_>
type Response = Vec<HypeTrainEvent, Global>
type Response = Vec<HypeTrainEvent, Global>
Response type. twitch’s response will deserialize to this.
sourceconst PATH: &'static str = "hypetrain/events"
const PATH: &'static str = "hypetrain/events"
The path to the endpoint relative to the helix root. eg.
channels
for Get Channel Informationsourceconst SCOPE: &'static [Scope] = _
const SCOPE: &'static [Scope] = _
Available on crate feature
twitch_oauth2
only.Scopes needed by this endpoint
sourceconst OPT_SCOPE: &'static [Scope] = _
const OPT_SCOPE: &'static [Scope] = _
Available on crate feature
twitch_oauth2
only.Optional scopes needed by this endpoint
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.
sourcefn get_bare_uri() -> Result<Uri, InvalidUri>
fn get_bare_uri() -> Result<Uri, InvalidUri>
Returns bare URI for the request, NOT including query parameters.
sourceimpl RequestGet for GetHypeTrainEventsRequest<'_>
impl RequestGet for GetHypeTrainEventsRequest<'_>
sourcefn create_request(
&self,
token: &str,
client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>
fn create_request(
&self,
token: &str,
client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>
Create a
http::Request
from this Request
in your clientsourcefn parse_response<B: Into<Bytes>>(
request: Option<Self>,
uri: &Uri,
response: Response<B>
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>where
Self: Sized,
fn parse_response<B: Into<Bytes>>(
request: Option<Self>,
uri: &Uri,
response: Response<B>
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>where
Self: Sized,
Parse response. Read more
sourcefn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>where
Self: Sized,
fn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>where
Self: Sized,
Parse a response string into the response.
sourceimpl<'a> Serialize for GetHypeTrainEventsRequest<'a>
impl<'a> Serialize for GetHypeTrainEventsRequest<'a>
impl<'a> Eq for GetHypeTrainEventsRequest<'a>
impl<'a> StructuralEq for GetHypeTrainEventsRequest<'a>
impl<'a> StructuralPartialEq for GetHypeTrainEventsRequest<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for GetHypeTrainEventsRequest<'a>
impl<'a> Send for GetHypeTrainEventsRequest<'a>
impl<'a> Sync for GetHypeTrainEventsRequest<'a>
impl<'a> Unpin for GetHypeTrainEventsRequest<'a>
impl<'a> UnwindSafe for GetHypeTrainEventsRequest<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.