15 releases (stable)

5.0.1 Aug 29, 2023
5.0.0 Oct 4, 2022
4.1.0 Sep 20, 2022
4.0.0 Mar 9, 2022
0.3.0 Nov 24, 2020

#336 in Network programming

Download history 390/week @ 2024-07-26 473/week @ 2024-08-02 364/week @ 2024-08-09 220/week @ 2024-08-16 207/week @ 2024-08-23 356/week @ 2024-08-30 346/week @ 2024-09-06 244/week @ 2024-09-13 355/week @ 2024-09-20 371/week @ 2024-09-27 194/week @ 2024-10-04 232/week @ 2024-10-11 356/week @ 2024-10-18 212/week @ 2024-10-25 276/week @ 2024-11-01 118/week @ 2024-11-08

1,023 downloads per month
Used in 3 crates

MIT license

350KB
5.5K SLoC

twitch-irc-rs

Rust CI status Crates.io Docs.rs

This is a client library to interface with Twitch chat.

This library is async and runs using the tokio runtime.

Example usage (This is the simple_listener example, see examples/simple_listener.rs and run it with cargo run --example simple_listener):

use twitch_irc::login::StaticLoginCredentials;
use twitch_irc::TwitchIRCClient;
use twitch_irc::{ClientConfig, SecureTCPTransport};

#[tokio::main]
pub async fn main() {
    // default configuration is to join chat as anonymous.
    let config = ClientConfig::default();
    let (mut incoming_messages, client) =
        TwitchIRCClient::<SecureTCPTransport, StaticLoginCredentials>::new(config);

    // first thing you should do: start consuming incoming messages,
    // otherwise they will back up.
    let join_handle = tokio::spawn(async move {
        while let Some(message) = incoming_messages.recv().await {
            println!("Received message: {:?}", message);
        }
    });

    // join a channel
    // This function only returns an error if the passed channel login name is malformed,
    // so in this simple case where the channel name is hardcoded we can ignore the potential
    // error with `unwrap`.
    client.join("sodapoppin".to_owned()).unwrap();

    // keep the tokio executor alive.
    // If you return instead of waiting the background task will exit.
    join_handle.await.unwrap();
}

Check out the documentation on docs.rs for more details.

Dependencies

~4–19MB
~300K SLoC