Struct splits_io_api::Runner

pub struct Runner {
    pub avatar: Option<Box<str>>,
    pub created_at: Box<str>,
    pub display_name: Option<Box<str>>,
    pub id: Box<str>,
    pub name: Box<str>,
    pub twitch_id: Option<Box<str>>,
    pub twitch_name: Option<Box<str>>,
    pub updated_at: Box<str>,
}

A Runner is a user who has at least one run tied to their account.

API Documentation

Fields

avatar: Option<Box<str>>

The avatar of the user.

created_at: Box<str>

The time and date at which this user first authenticated with Splits.io. This field conforms to ISO 8601.

display_name: Option<Box<str>>

The display name of the user.

id: Box<str>

The unique ID of the user.

name: Box<str>

The Splits.io username of the user.

twitch_id: Option<Box<str>>

The Twitch ID of the user.

twitch_name: Option<Box<str>>

The Twitch name of the user.

updated_at: Box<str>

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

Implementations

impl Runner

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

Searches for a Runner based on the name of the runner.

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

Gets the Runner that is associated with the current user.

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

Gets a Runner based on the name of the runner.

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

Gets the Runs that are associated with the Runner.

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

Gets the personal best Runs that are associated with the Runner.

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

Gets the Games that are associated with the Runner.

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

Gets the Categories that are associated with the Runner.

Trait Implementations

impl Debug for Runner

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Runner

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

Deserialize this value from the given Serde deserializer.