Struct twitchchat::AsyncRunner

pub struct AsyncRunner {
    pub identity: Identity,
    // some fields omitted
}

This is supported on crate feature async only.

An asynchronous runner

Fields

identity: Identity

You identity that Twitch gives when you connected

Implementations

impl AsyncRunner

pub async fn connect<C, '_>(
    connector: C,
    user_config: &'_ UserConfig
) -> Result<Self, Error> where
    C: Connector,
    &'a C::Output: AsyncRead + AsyncWrite + Send + Sync + Unpin, 

Connect with the provided connector and the provided UserConfig

This returns the Runner with your identity set.

pub fn is_on_channel(&self, channel: &str) -> bool

Check whether you're on this channel

pub fn get_channel_mut(&mut self, channel: &str) -> Option<&mut Channel>

Get a specific channel.

This is useful for changing the rate limit/state manually.

pub fn writer(&self) -> AsyncWriter<MpscWriter>

Get a clonable writer you can use

pub fn quit_handle(&self) -> NotifyHandle

Get a handle that you can trigger a normal 'quit'.

You can also do AsyncWriter::quit.

pub async fn join<'_, '_>(&'_ mut self, channel: &'_ str) -> Result<(), Error>

Join channel and wait for it to complete

pub async fn part<'_, '_>(&'_ mut self, channel: &'_ str) -> Result<(), Error>

Part channel and wait for it to complete

pub async fn next_message<'_>(&'_ mut self) -> Result<Status<'static>, Error>

Get the next message. You'll usually want to call this in a loop

pub async fn step<'_>(&'_ mut self) -> Result<StepResult<'static>, Error>

Single step the loop. This is useful for testing.

Trait Implementations

impl Debug for AsyncRunner

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

Formats the value using the given formatter.

impl Stream for AsyncRunner

type Item = Commands<'static>

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    ctx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.