Struct speedrun_api::api::games::GameRecordsBuilder

pub struct GameRecordsBuilder<'a> { /* private fields */ }

Builder for GameRecords.

Implementations

impl<'a> GameRecordsBuilder<'a>

pub fn id<VALUE: Into<GameId<'a>>>(&mut self, value: VALUE) -> &mut Self

ID of the game to retrieve records for.

pub fn top<VALUE: Into<i64>>(&mut self, value: VALUE) -> &mut Self

Return the top places (this can result in more than top runs!). Defaults to 3.

pub fn scope<VALUE: Into<LeaderboardScope>>(&mut self, value: VALUE) -> &mut Self

When set to LeaderboardScope::FullGame, only full-game categories will be included. When set to LeaderboardScope::Levels only individual levels are returned. Defaults to LeaderboardScope::All.

pub fn miscellaneous<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

When false, miscellaneous categories will not be included in the results.

pub fn skip_empty<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

When true, empty leaderboards will not be included in the results.

pub fn build(&self) -> Result<GameRecords<'a>, GameRecordsBuilderError>

Builds a new GameRecords.

Errors

If a required field has not been initialized.

impl<'a> GameRecordsBuilder<'a>

pub fn embed(&mut self, embed: LeaderboardEmbeds) -> &mut Self

Add an embedded resource to this result.

pub fn embeds<I>(&mut self, iter: I) -> &mut Selfwhere
    I: Iterator<Item = LeaderboardEmbeds>,

Add multiple embedded resources to this result.

Trait Implementations

impl<'a> Clone for GameRecordsBuilder<'a>

fn clone(&self) -> GameRecordsBuilder<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for GameRecordsBuilder<'a>

fn default() -> Self

Returns the “default value” for a type.