ircbot 0.4.2

An async IRC bot framework for Rust powered by Tokio and procedural macros
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

//! Connecting over TLS.
//!
//! Run with the `tls` feature:
//!
//!     cargo run --example tls_bot --features tls

use ircbot::{bot, Context, Result, Server};

#[bot]
impl TlsBot {
    #[command("ping")]
    async fn ping(&self, ctx: Context) -> Result {
        ctx.reply("pong!")
    }
}

#[tokio::main]
async fn main() -> std::result::Result<(), Box<dyn std::error::Error + Send + Sync>> {
    tracing_subscriber::fmt()
        .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
        .init();

    // The server value decides the transport. A bare "host:port" string would
    // connect in plaintext; `Server::tls` negotiates TLS and verifies the
    // certificate against the platform's root store. `new` takes anything that
    // converts into a `Server`, so the builder chain can be passed straight in;
    // it is bound to a `Server` here only so it can be printed below.
    let server: Server = Server::tls("irc.libera.chat:6697").into();

    // A network with a private CA or a self-signed certificate is handled by
    // trusting that certificate specifically — verification stays on:
    //
    //     Server::tls("irc.internal.example:6697")
    //         .with_extra_root_pem(std::fs::read("ca.pem")?)
    //
    // A client certificate authenticates the bot via CertFP / SASL EXTERNAL:
    //
    //     Server::tls("irc.libera.chat:6697")
    //         .with_client_cert_pem(std::fs::read("bot.pem")?)
    //
    // When connecting to an IP address whose certificate names a hostname,
    // `with_sni("irc.example.net")` sets the name to verify against.

    println!("tls_bot example compiled successfully.");
    println!("Connecting for real is two lines:");
    println!("  let bot = TlsBot::new(\"ircbot\", {server}, [\"#rust\"]).await?;");
    println!("  bot.main_loop().await?;");

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use ircbot::testing::TestContext;

    #[tokio::test]
    async fn ping_replies_with_pong() {
        let bot = TlsBot::default();
        let mut tc = TestContext::channel("#test", "alice", "!ping");
        bot.ping(tc.take_ctx()).await.unwrap();
        assert_eq!(
            tc.next_reply(),
            Some("PRIVMSG #test :alice, pong!\r\n".to_string()),
        );
    }
}