Struct Bot

pub struct Bot<S: Send + Sync + ?Sized + 'static> { /* private fields */ }

Implementations

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

pub async fn new( category_slug: &str, client_id: &str, client_secret: &str, state: Arc<S>, ) -> Result<Self, Error>

pub async fn new_with_host( host_info: HostInfo, category_slug: &str, client_id: &str, client_secret: &str, state: Arc<S>, ) -> Result<Self, Error>

pub fn extra_room_sender(&self) -> Sender<String>

Returns a sender that takes extra room slugs (e.g. as returned from crate::StartRace::start) and has the bot handle those rooms.

This can be used to have the bot handle unlisted rooms, which aren’t detected automatically since they’re not listed on the category detail API endpoint. It can also be used to send listed rooms created by the bot to spawn the room handler immediately rather than waiting for the next check for new rooms.

pub async fn run<H: RaceHandler<S>>(self) -> Result<Never, Error>

Run the bot. Requires an active tokio runtime.

pub async fn run_until<H: RaceHandler<S>, T, Fut: Future<Output = T>>( self, shutdown: Fut, ) -> Result<T, Error>

Run the bot until the shutdown future resolves. Requires an active tokio runtime. shutdown must be cancel safe.