Struct splits_io_api::Game

pub struct Game {
    pub categories: Option<Vec<Category>>,
    pub created_at: Box<str>,
    pub id: Box<str>,
    pub name: Box<str>,
    pub shortname: Option<Box<str>>,
    pub updated_at: Box<str>,
}

A Game is a collection of information about a game, and a container for Categories.

API Documentation

Fields

categories: Option<Vec<Category>>

The known speedrun categories for this game.

created_at: Box<str>

The time and date at which this game was created on splits.io. This field conforms to ISO 8601.

id: Box<str>

The unique ID of the game.

name: Box<str>

The full title of the game, like “Super Mario Sunshine”.

shortname: Option<Box<str>>

A shortened title of the game, like “sms”, if it is known. Where possible, this name tries to match with those on SpeedRunsLive and/or Speedrun.com.

updated_at: Box<str>

The time and date at which this game was most recently modified on splits.io. This field conforms to ISO 8601.

Implementations

impl Game

pub async fn search(client: &Client, name: &str) -> Result<Vec<Game>, Error>

Searches for a Game based on the name of the game.

pub async fn get(client: &Client, shortname: &str) -> Result<Game, Error>

Gets a Game based on the shortened title of the game.

pub async fn categories(&self, client: &Client) -> Result<Vec<Category>, Error>

Gets the Categories that belong to the Game based on the shortened title of the game.

pub async fn runs(&self, client: &Client) -> Result<Vec<Run>, Error>

Gets the Runs that belong to the Game based on the shortened title of the game.

pub async fn runners(&self, client: &Client) -> Result<Vec<Runner>, Error>

Gets the Runners that belong to the Game based on the shortened title of the game.

Trait Implementations

impl Debug for Game

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Game

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.