Struct tmi::client::Client

pub struct Client { /* private fields */ }

Twitch IRC client.

This is the main interface for interacting with Twitch IRC.

This interface provides:

• Connection handshake
• Reconnect with backoff
• Receiving and sending messages

It is a low-level interface, which means it does not automatically handle:

• Rate limiting
• Same message bypass
• Reconnects / rejoining channels
• Latency measurement

Implementations

impl Client

pub async fn recv(&mut self) -> Result<IrcMessage, RecvError>

Read a single IrcMessage from the underlying stream.

impl Client

pub async fn send_raw<'a, S>(&mut self, s: S) -> Result<(), SendError>

where S: TryInto<RawMessage<'a>>, SendError: From<S::Error>,

Send a raw string through the TCP socket.

⚠ This call is not rate limited in any way.

⚠ The string MUST be terminated by \r\n.

pub fn privmsg<'a>(&'a mut self, channel: &'a str, text: &'a str) -> Privmsg<'a>

Create a privmsg from a channel and text.

client
  .privmsg(msg.channel(), "yo")
  .reply_to(msg.message_id())
  .send()
  .await?;

You can specify additional properties using the builder methods:

• reply_to: to specify a reply-parent-msg-id tag, which makes this privmsg a reply to another message.
• client_nonce: to identify the message in the Notice which Twitch may send as a response to this message.

pub async fn ping(&mut self, nonce: &str) -> Result<(), SendError>

Send a PING command with an optional nonce argument.

pub async fn pong(&mut self, ping: &Ping<'_>) -> Result<(), SendError>

Send a PONG command in response to a PING.

pub async fn join(&mut self, channel: impl AsRef<str>) -> Result<(), SendError>

Send a JOIN command.

⚠ This call is not rate limited in any way.

⚠ channel MUST be a valid channel name prefixed by #.

pub async fn join_all<'a, I, C>(&mut self, channels: I) -> Result<(), SendError>

where I: IntoIterator<Item = C>, C: AsRef<str>,

Send a JOIN command.

⚠ This call is not rate limited in any way.

⚠ Each channel in channels MUST be a valid channel name prefixed by #.

impl Client

pub fn builder() -> ClientBuilder

The ClientBuilder provides a builder for setting up the client configuration.

pub fn anonymous() -> impl Future<Output = Result<Client, ConnectError>>

Attemps to connect anonymously.

pub async fn reconnect(&mut self) -> Result<(), ReconnectError>

Attempt to reconnect to Twitch IRC.

impl Client

pub fn config(&self) -> &Config

pub fn credentials(&self) -> &Credentials