Struct twitchchat::Control

pub struct Control { /* fields omitted */ }

A control type for writing messages to the client, or stopping it.

Implementations

impl Control

pub fn writer(&mut self) -> &mut Writer

This is supported on feature="tokio" only.

Get a mutable reference to the Writer

You can clone this to pass around it around

pub fn stop(&self)

This is supported on feature="tokio" only.

Signal the client to stop

Example

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);

pub async fn wait_for_reconnect<'_>(&'_ self)

This is supported on feature="tokio" only.

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

Trait Implementations

impl Clone for Control

fn clone(&self) -> Control

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Control

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.