Struct racetime::handler::RaceContext

pub struct RaceContext {
    pub sender: Arc<Mutex<WsSink>>,
    /* private fields */
}

A type passed to RaceHandler callback methods which can be used to check the current status of the race or send messages.

Fields

sender: Arc<Mutex<WsSink>>

Implementations

impl RaceContext

pub async fn data(&self) -> RwLockReadGuard<'_, RaceData>

Returns the current state of the race.

pub async fn send_raw(&self, message: &Json) -> Result<(), Error>

Sends a raw JSON message to the server.

The methods set_raceinfo through remove_monitor should be preferred.

pub async fn send_message(&self, message: &str) -> Result<(), Error>

Send a chat message to the race room.

message should be the message string you want to send.

pub async fn set_raceinfo(
    &self,
    info: &str,
    pos: RaceInfoPos
) -> Result<(), Error>

Set the info field on the race room’s data.

info should be the information you wish to set, and pos the behavior in case there is existing info.

pub async fn set_open(&self) -> Result<(), Error>

Set the room in an open state.

pub async fn set_invitational(&self) -> Result<(), Error>

Set the room in an invite-only state.

pub async fn force_start(&self) -> Result<(), Error>

Forces a start of the race.

pub async fn cancel_race(&self) -> Result<(), Error>

Forcibly cancels a race.

pub async fn invite_user(&self, user: &str) -> Result<(), Error>

Invites a user to the race.

user should be the hashid of the user.

pub async fn accept_request(&self, user: &str) -> Result<(), Error>

Accepts a request to join the race room.

user should be the hashid of the user.

pub async fn force_unready(&self, user: &str) -> Result<(), Error>

Forcibly unreadies an entrant.

user should be the hashid of the user.

pub async fn remove_entrant(&self, user: &str) -> Result<(), Error>

Forcibly removes an entrant from the race.

user should be the hashid of the user.

pub async fn add_monitor(&self, user: &str) -> Result<(), Error>

Adds a user as a race monitor.

user should be the hashid of the user.

pub async fn remove_monitor(&self, user: &str) -> Result<(), Error>

Removes a user as a race monitor.

user should be the hashid of the user.

Trait Implementations

impl Clone for RaceContext

fn clone(&self) -> RaceContext

Returns a copy of the value.

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

Performs copy-assignment from source.