Struct splits_io_api::Run

pub struct Run {

    pub attempts: Option<u32>,
    pub category: Option<Category>,
    pub created_at: Box<str>,
    pub default_timing: Box<str>,
    pub game: Option<Game>,
    pub gametime_duration_ms: Option<f64>,
    pub gametime_sum_of_best_ms: Option<f64>,
    pub histories: Option<Vec<RunItemHistories>>,
    pub id: Option<Box<str>>,
    pub image_url: Option<Box<str>>,
    pub program: Box<str>,
    pub realtime_duration_ms: Option<f64>,
    pub realtime_sum_of_best_ms: Option<f64>,
    pub runners: Vec<Runner>,
    pub segments: Vec<Segment>,
    pub srdc_id: Option<Box<str>>,
    pub updated_at: Box<str>,
    pub video_url: Option<Box<str>>,
}

A Run maps 1:1 to an uploaded splits file.

API Documentation

Fields

attempts: Option<u32>

The number of run attempts recorded by the timer that generated the run’s source file, if supported by the source timer.

category: Option<Category>

The category which was run, if it was supplied by the runner and determined from the source file.

created_at: Box<str>

The time and date at which this run’s source file was uploaded to Splits.io. This field conforms to ISO 8601.

default_timing: Box<str>

The timing method used for the run. Will be either real or game.

game: Option<Game>

The game which was run, if it was supplied by the runner and determined from the source file.

gametime_duration_ms: Option<f64>

Gametime duration in milliseconds of the run.

gametime_sum_of_best_ms: Option<f64>

Gametime sum of best in milliseconds of the run.

histories: Option<Vec<RunItemHistories>>

Ordered history objects of all previous attempts. The first item is the first run recorded by the runner’s timer into the source file. The last item is the most recent one. This field is only nonempty if the source timer records history.

id: Option<Box<str>>

Unique ID for identifying the run on Splits.io. This can be used to construct a user-facing URL or an API-facing one.

image_url: Option<Box<str>>

A screenshot of the timer after a finished run, if it was supplied by the runner. This is typically supplied automatically by timers which support auto-uploading runs to Splits.io.

program: Box<str>

The name of the timer with which the run was recorded. This is typically an all lowercase, no-spaces version of the program name.

realtime_duration_ms: Option<f64>

Realtime duration in milliseconds of the run.

realtime_sum_of_best_ms: Option<f64>

Realtime sum of best in milliseconds of the run.

runners: Vec<Runner>

The runner(s) who performed the run, if they claim credit.

segments: Vec<Segment>

The associated segments for the run.

srdc_id: Option<Box<str>>

Unique ID for identifying the run on Speedrun.com. This is typically supplied by the runner manually.

updated_at: Box<str>

The time and date at which this run was most recently modified on Splits.io (modify events include disowning, adding a video or Speedrun.com association, and changing the run’s game/category). This field conforms to ISO 8601.

video_url: Option<Box<str>>

A URL for a Twitch, YouTube, or Hitbox video which can be used as proof of the run. This is supplied by the runner.

Implementations

impl Run

pub async fn download(
    &self,
    client: &Client
) -> Result<impl Deref<Target = [u8]>, Error>

Downloads the splits for the Run.

pub async fn get(client: &Client, id: &str, historic: bool) -> Result<Run, Error>

Gets a Run.

pub async fn upload(client: &Client, run: &[u8]) -> Result<UploadedRun, Error>

Uploads a run to Splits.io.

pub async fn upload_lazy<E: Error>(
    client: &Client,
    write_run: impl FnOnce(&mut RunWriter) -> Result<(), E>
) -> Result<UploadedRun, Error>

Uploads a run to Splits.io by using a RunWriter in order to write the request body.

pub fn url(&self) -> Result<Url, Error>

Retrieves the public URL of the run. This may fail if the run is unidentifiable.

Trait Implementations

impl Debug for Run

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Run

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

Deserialize this value from the given Serde deserializer.