Crate tmi

source ·
Expand description

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

$ cargo add tmi
async fn run(channels: &[tmi::Channel]) -> anyhow::Result<()> {
  let mut client = tmi::Client::connect().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

Modules

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

Macros

  • Constructs a whitelist from a list of tags names.