1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
use {super::*, crate::*}; #[derive(Clone)] /// A control type for writing messages to the client, or stopping it. pub struct Control { pub(super) writer: Writer, pub(super) stop: abort::Abort, pub(super) ready: std::sync::Arc<tokio::sync::Notify>, } impl Control { /// Get a mutable reference to the [Writer](./encode/struct.AsyncEncoder.html) /// /// You can clone this to pass around it around pub fn writer(&mut self) -> &mut Writer { &mut self.writer } /// Signal the client to stop /// /// # Example /// ```rust /// # use twitchchat::{Runner, Status, RateLimit, Dispatcher, Connector}; /// # use tokio::spawn; /// # let conn = Connector::new(move || async move { Ok(tokio_test::io::Builder::new().wait(std::time::Duration::from_millis(10000)).build()) }); /// # let fut = async move { /// let (mut runner, control) = Runner::new(Dispatcher::default()); /// /// // calling stop will cause 'run' to return Ok(Status::Canceled) /// spawn(async move { control.stop() }); /// /// assert_eq!(runner.run_to_completion(conn).await.unwrap(), Status::Canceled); /// # }; /// # tokio::runtime::Runtime::new().unwrap().block_on(fut); /// ``` pub fn stop(&self) { self.stop.cancel() } /// This will block until you're reconnected /// /// If you've not connected yet then this won't block /// /// This is useful for determining when a reconnect has happened pub async fn wait_for_reconnect(&self) { self.ready.notified().await } } impl std::fmt::Debug for Control { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_struct("Control").finish() } }