Crate tmi

tmi-rs  

Blazingly fast 🚀 Rust 🦀 library for interacting with twitch.tv’s chat interface.

Quick Start

$ cargo add tmi anyhow tokio -F tokio/full

const CHANNELS: &[&str] = &["#forsen"];

#[tokio::main]
async fn main() -> anyhow::Result<()> {
  let mut client = tmi::Client::anonymous().await?;
  client.join_all(CHANNELS).await?;

  loop {
    let msg = client.recv().await?;
    match msg.as_typed()? {
      tmi::Message::Privmsg(msg) => {
        println!("{}: {}", msg.sender().name(), msg.text());
      }
      tmi::Message::Reconnect => {
        client.reconnect().await?;
        client.join_all(CHANNELS).await?;
      }
      tmi::Message::Ping(ping) => {
        client.pong(&ping).await?;
      }
      _ => {}
    }
  }
}

Performance

Calling the library blazingly fast is done in jest, but it is true that tmi-rs is very fast. tmi-rs is part of the twitch-irc-benchmarks, where it is currently the fastest implementation by a significant margin (nearly 6x faster than the second best Rust implementation). This is because underlying IRC message parser is handwritten and accelerated using SIMD on x86 and ARM. For every other architecture, there is a scalar fallback.

Acknowledgements

Initially based on dank-twitch-irc, and twitch-irc-rs. Lots of test messages were taken directly from twitch-irc-rs.

Re-exports

• pub use client::Client;
• pub use client::Credentials;
• pub use msg::*;
• pub use irc::*;

Modules

• client
  Twitch IRC Client
• common
  Random types and utilties used by the library.
• irc
  IRCv3 Message parser
• msg
  Twitch message types

Macros

• whitelist
  Constructs a whitelist from a list of tags names.