Struct twitch_api2::helix::bits::GetBitsLeaderboardRequest
source · [−]#[non_exhaustive]pub struct GetBitsLeaderboardRequest {
pub count: Option<i32>,
pub period: Option<String>,
pub started_at: Option<Timestamp>,
pub user_id: Option<UserId>,
}
helix
only.Expand description
Query Parameters for Get Bits Leaderboard
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.count: Option<i32>
Number of results to be returned. Maximum: 100. Default: 10.
period: Option<String>
Time period over which data is aggregated (PST time zone). This parameter interacts with started_at. Valid values follow. Default: “all”.
- “day” – 00:00:00 on the day specified in started_at, through 00:00:00 on the following day.
- “week” – 00:00:00 on Monday of the week specified in started_at, through 00:00:00 on the following Monday.
- “month” – 00:00:00 on the first day of the month specified in started_at, through 00:00:00 on the first day of the following month.
- “year” – 00:00:00 on the first day of the year specified in started_at, through 00:00:00 on the first day of the following year.
- “all” – The lifetime of the broadcaster’s channel. If this is specified (or used by default), started_at is ignored.
started_at: Option<Timestamp>
Timestamp for the period over which the returned data is aggregated. Must be in RFC 3339 format. If this is not provided, data is aggregated over the current period; e.g., the current day/week/month/year. This value is ignored if period is “all”.
user_id: Option<UserId>
ID of the user whose results are returned; i.e., the person who paid for the Bits.
Implementations
sourceimpl GetBitsLeaderboardRequest
impl GetBitsLeaderboardRequest
sourcepub fn builder() -> GetBitsLeaderboardRequestBuilder<((), (), (), ())>
pub fn builder() -> GetBitsLeaderboardRequestBuilder<((), (), (), ())>
Create a builder for building GetBitsLeaderboardRequest
.
On the builder, call .count(...)
(optional), .period(...)
(optional), .started_at(...)
(optional), .user_id(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of GetBitsLeaderboardRequest
.
Trait Implementations
sourceimpl Clone for GetBitsLeaderboardRequest
impl Clone for GetBitsLeaderboardRequest
sourcefn clone(&self) -> GetBitsLeaderboardRequest
fn clone(&self) -> GetBitsLeaderboardRequest
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 more
sourceimpl Debug for GetBitsLeaderboardRequest
impl Debug for GetBitsLeaderboardRequest
sourceimpl<'de> Deserialize<'de> for GetBitsLeaderboardRequest
impl<'de> Deserialize<'de> for GetBitsLeaderboardRequest
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 PartialEq<GetBitsLeaderboardRequest> for GetBitsLeaderboardRequest
impl PartialEq<GetBitsLeaderboardRequest> for GetBitsLeaderboardRequest
sourcefn eq(&self, other: &GetBitsLeaderboardRequest) -> bool
fn eq(&self, other: &GetBitsLeaderboardRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &GetBitsLeaderboardRequest) -> bool
fn ne(&self, other: &GetBitsLeaderboardRequest) -> bool
This method tests for !=
.
sourceimpl Request for GetBitsLeaderboardRequest
impl Request for GetBitsLeaderboardRequest
type Response = BitsLeaderboard
type Response = BitsLeaderboard
Response type. twitch’s response will deserialize to this.
sourceconst PATH: &'static str = "bits/leaderboard"
const PATH: &'static str = "bits/leaderboard"
The path to the endpoint relative to the helix root. eg. channels
for Get Channel Information
sourceconst SCOPE: &'static [Scope] = &[]
const SCOPE: &'static [Scope] = &[]
twitch_oauth2
only.Scopes needed by this endpoint
sourceconst OPT_SCOPE: &'static [Scope] = &[]
const OPT_SCOPE: &'static [Scope] = &[]
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 GetBitsLeaderboardRequest
impl RequestGet for GetBitsLeaderboardRequest
sourcefn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
fn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
Parse a response string into the response.
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 client
sourceimpl Serialize for GetBitsLeaderboardRequest
impl Serialize for GetBitsLeaderboardRequest
impl StructuralPartialEq for GetBitsLeaderboardRequest
Auto Trait Implementations
impl RefUnwindSafe for GetBitsLeaderboardRequest
impl Send for GetBitsLeaderboardRequest
impl Sync for GetBitsLeaderboardRequest
impl Unpin for GetBitsLeaderboardRequest
impl UnwindSafe for GetBitsLeaderboardRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
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<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more