Struct speedrun_api::api::runs::CreateRunBuilder

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

Builder for CreateRun.

Implementations

impl<'a> CreateRunBuilder<'a>

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

Category ID for the run.

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

Level ID for individual level runs.

pub fn date<VALUE: Into<Cow<'a, str>>>(&mut self, value: VALUE) -> &mut Self

Optional date the run was performed (defaults to the current date).

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

Optional region for the run. Some games require a region to be submitted.

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

Optional platform for the run. Some games require a platform to be submitted.

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

If the run has been verified by a moderator. Can only be set if the submitting user is a moderator of the game.

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

When true the run was performed on an emulator (default: false).

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

A valid video URL. Optional, but some games require a video to be included.

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

Optional comment on the run. Can include additional video URLs.

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

Splits.io ID or URL for the splits for the run.

pub fn variables<VALUE: Into<HashMap<VariableId<'a>, ValueType<'a>>>>(
    &mut self,
    value: VALUE
) -> &mut Self

Variable values for the new run. Some games have mandatory variables.

pub fn build(&self) -> Result<CreateRun<'a>, CreateRunBuilderError>

Builds a new CreateRun.

Errors

If a required field has not been initialized.

impl<'a> CreateRunBuilder<'a>

pub fn realtime<T: Into<f64>>(&mut self, value: T) -> &mut Self

Real-world time of the run

pub fn realtime_noloads<T: Into<f64>>(&mut self, value: T) -> &mut Self

Real-world time of the run, excluding the loading times

pub fn ingame<T: Into<f64>>(&mut self, value: T) -> &mut Self

Time measured by the game

pub fn player(&mut self, player: Player<'a>) -> &mut Self

Add a player to this run.

pub fn players<I>(&mut self, iter: I) -> &mut Selfwhere
    I: Iterator<Item = Player<'a>>,

Add multiple players to this run.

Trait Implementations

impl<'a> Clone for CreateRunBuilder<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for CreateRunBuilder<'a>

fn default() -> Self

Returns the “default value” for a type.