Struct twitch_api2::helix::bits::get_bits_leaderboard::GetBitsLeaderboardRequest [−][src]
#[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.Query Parameters for Get Bits Leaderboard
Fields (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
impl GetBitsLeaderboardRequest
[src]
impl GetBitsLeaderboardRequest
[src]pub fn builder() -> GetBitsLeaderboardRequestBuilder<((), (), (), ())>
[src]
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
impl Clone for GetBitsLeaderboardRequest
[src]
impl Clone for GetBitsLeaderboardRequest
[src]fn clone(&self) -> GetBitsLeaderboardRequest
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'de> Deserialize<'de> for GetBitsLeaderboardRequest
[src]
impl<'de> Deserialize<'de> for GetBitsLeaderboardRequest
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl PartialEq<GetBitsLeaderboardRequest> for GetBitsLeaderboardRequest
[src]
impl PartialEq<GetBitsLeaderboardRequest> for GetBitsLeaderboardRequest
[src]fn eq(&self, other: &GetBitsLeaderboardRequest) -> bool
[src]
fn ne(&self, other: &GetBitsLeaderboardRequest) -> bool
[src]
impl Request for GetBitsLeaderboardRequest
[src]
impl Request for GetBitsLeaderboardRequest
[src]type Response = BitsLeaderboard
Response type. twitch’s response will deserialize to this.
const PATH: &'static str
[src]
const SCOPE: &'static [Scope]
[src]
const OPT_SCOPE: &'static [Scope]
[src]
fn query(&self) -> Result<String, Error>
[src]
fn get_uri(&self) -> Result<Uri, InvalidUri>
[src]
fn get_bare_uri() -> Result<Uri, InvalidUri>
[src]
impl RequestGet for GetBitsLeaderboardRequest
[src]
impl RequestGet for GetBitsLeaderboardRequest
[src]fn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
_: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
[src]
request: Option<Self>,
uri: &Uri,
response: &str,
_: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
fn create_request(
&self,
token: &str,
client_id: &str
) -> Result<Request<Vec<u8>>, CreateRequestError>
[src]
&self,
token: &str,
client_id: &str
) -> Result<Request<Vec<u8>>, CreateRequestError>
fn parse_response(
request: Option<Self>,
uri: &Uri,
response: Response<Vec<u8>>
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
[src]
request: Option<Self>,
uri: &Uri,
response: Response<Vec<u8>>
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
impl Serialize for GetBitsLeaderboardRequest
[src]
impl Serialize for GetBitsLeaderboardRequest
[src]Auto Trait Implementations
impl RefUnwindSafe for GetBitsLeaderboardRequest
impl RefUnwindSafe for GetBitsLeaderboardRequest
impl Send for GetBitsLeaderboardRequest
impl Send for GetBitsLeaderboardRequest
impl Sync for GetBitsLeaderboardRequest
impl Sync for GetBitsLeaderboardRequest
impl Unpin for GetBitsLeaderboardRequest
impl Unpin for GetBitsLeaderboardRequest
impl UnwindSafe for GetBitsLeaderboardRequest
impl UnwindSafe for GetBitsLeaderboardRequest
Blanket Implementations
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
impl<T> WithSubscriber for T
[src]pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,