Struct twitch_api2::helix::bits::GetBitsLeaderboardRequest

#[non_exhaustive]
pub struct GetBitsLeaderboardRequest {
    pub count: Option<i32>,
    pub period: Option<String>,
    pub started_at: Option<Timestamp>,
    pub user_id: Option<UserId>,
}

Available on crate feature helix only.

Query Parameters for Get Bits Leaderboard

get-bits-leaderboard

Fields (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.

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

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

impl Clone for GetBitsLeaderboardRequest

fn clone(&self) -> GetBitsLeaderboardRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetBitsLeaderboardRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GetBitsLeaderboardRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<GetBitsLeaderboardRequest> for GetBitsLeaderboardRequest

fn eq(&self, other: &GetBitsLeaderboardRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GetBitsLeaderboardRequest) -> bool

This method tests for !=.

impl Request for GetBitsLeaderboardRequest

type Response = BitsLeaderboard

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

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

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

const OPT_SCOPE: &'static [Scope] = &[]

Available on crate feature twitch_oauth2 only.

Optional scopes needed by this endpoint

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.

impl RequestGet for GetBitsLeaderboardRequest

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.

fn create_request(
    &self,
    token: &str,
    client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>

Create a http::Request from this Request in your client

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.

impl Serialize for GetBitsLeaderboardRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GetBitsLeaderboardRequest