Struct racetime::handler::RaceContext

pub struct RaceContext<S: Send + Sync + ?Sized + 'static> {
    pub global_state: Arc<S>,
    /* private fields */
}

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

While a future returned from a callback method is running, data will not change and no other callbacks will be processed. Clone can be used to keep a value of this type past the end of a handler callback, e.g. by passing it into tokio::spawn. If you do so, data can be called to check the current state of the race.

Fields

global_state: Arc<S>

Implementations

impl<S: Send + Sync + ?Sized + 'static> RaceContext<S>

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

Returns the current state of the race.

See the type-level documentation for the semantics of using a RaceContext for an extended period of time.

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

Send a simple chat message to the race room.

See send_message for more options.

pub async fn send_message( &self, message: &str, pinned: bool, actions: Vec<(&str, ActionButton)> ) -> Result<(), Error>

Send a chat message to the race room.

• message should be the message string you want to send.
• If pinned is set to true, the sent message will be automatically pinned.
• If actions is provided, action buttons will appear below your message for users to click on. See action buttons for more details.

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

Send a direct message only visible to its recipient.

• message should be the message string you want to send.
• direct_to should be the hashid of the user.

pub async fn pin_message(&self, message_id: &str) -> Result<(), Error>

Pin a chat message.

message_id should be the id field of a ChatMessage.

pub async fn unpin_message(&self, message_id: &str) -> Result<(), Error>

Unpin a chat message.

message_id should be the id field of a ChatMessage.

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

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

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

Set the info_user 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<S: Send + Sync + ?Sized + 'static> Clone for RaceContext<S>

fn clone(&self) -> Self

This is a cheap operation since this type is a wrapper around some Arcs. See the type-level documentation for the semantics of using a RaceContext for an extended period of time.

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

Performs copy-assignment from source.