Struct racetime::StartRace

pub struct StartRace {

    pub goal: String,
    pub goal_is_custom: bool,
    pub team_race: bool,
    pub invitational: bool,
    pub unlisted: bool,
    pub info_user: String,
    pub info_bot: String,
    pub require_even_teams: bool,
    pub start_delay: u8,
    pub time_limit: u8,
    pub time_limit_auto_complete: bool,
    pub streaming_required: bool,
    pub auto_start: bool,
    pub allow_comments: bool,
    pub hide_comments: bool,
    pub allow_prerace_chat: bool,
    pub allow_midrace_chat: bool,
    pub allow_non_entrant_chat: bool,
    pub chat_message_delay: u8,
}

Fields

goal: String

If the race has already started, this must match the current goal.

goal_is_custom: bool

If the race has already started, this must match the current goal.

team_race: bool

invitational: bool

If editing the race, this must match the current state. Use RaceContext::set_invitational or RaceContext::set_open instead.

unlisted: bool

Bots always have permission to set this field.

info_user: String

info_bot: String

require_even_teams: bool

start_delay: u8

Number of seconds the countdown should run for. Must be in 10..=60. If the race has already started, this must match the current delay.

time_limit: u8

Maximum number of hours the race is allowed to run for. Must be in 1..=72. If the race has already started, this must match the current limit.

time_limit_auto_complete: bool

streaming_required: bool

Bots always have permission to set this field.

If the race has already started, this cannot be changed.

auto_start: bool

If the race has already started, this cannot be changed.

allow_comments: bool

hide_comments: bool

allow_prerace_chat: bool

allow_midrace_chat: bool

allow_non_entrant_chat: bool

chat_message_delay: u8

Number of seconds to hold a message for before displaying it. Doesn’t affect race monitors or moderators. Must be in 0..=90.

Implementations

impl StartRace

pub async fn start( &self, access_token: &str, client: &Client, category: &str ) -> Result<String, Error>

Creates a race room with the specified configuration and returns its slug.

An access token can be obtained using authorize.

pub async fn start_with_host( &self, host_info: &HostInfo, access_token: &str, client: &Client, category: &str ) -> Result<String, Error>

pub async fn edit( &self, access_token: &str, client: &Client, category: &str, race_slug: &str ) -> Result<(), Error>

Edits the given race room.

Due to a limitation of the racetime.gg API, all fields including ones that should remain the same must be specified.

An access token can be obtained using authorize.

pub async fn edit_with_host( &self, host_info: &HostInfo, access_token: &str, client: &Client, category: &str, race_slug: &str ) -> Result<(), Error>