Merge pull request #260 from aatxe/develop

Release v1.0.0

Author: aatxe

.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  pull_request: {}
+  push:
+    branches:
+      - develop
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        rust: ["1.71", stable]
+    steps:
+    - uses: actions/checkout@v3
+    - uses: dtolnay/rust-toolchain@master
+      with:
+        toolchain: ${{matrix.rust}}
+    - run: cargo build --workspace --all-targets
+    - run: cargo build --workspace --all-targets --no-default-features
+    - run: cargo build --workspace --all-targets --features tls-native
+    - run: cargo build --workspace --all-targets --features tls-rust
+    # runs all tests for all targets, including examples and benchmarks. Only on
+    # stable, since we don't care about tests running on MSRV.
+    - run: cargo test --workspace --all-targets
+      if: matrix.rust == 'stable'
+    # runs all documentation tests separately, since those are not picked up by
+    # `--all-targets`.
+    - run: cargo test --workspace --doc
+      if: matrix.rust == 'stable'
+
+  rustfmt:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: dtolnay/rust-toolchain@stable
+      with:
+        components: rustfmt
+    - run: cargo fmt --all --check

Cargo.toml

@@ -1,15 +1,16 @@
 [package]
 name = "irc"
-version = "0.15.0"
-description = "the irc crate – usable, async IRC for Rust "
+version = "1.0.0"
 authors = ["Aaron Weiss <aweiss@hey.com>"]
+edition = "2018"
+rust-version = "1.71"
+description = "the irc crate – usable, async IRC for Rust"
+documentation = "https://docs.rs/irc/"
+readme = "README.md"
+repository = "https://github.com/aatxe/irc"
 license = "MPL-2.0"
 keywords = ["irc", "client", "thread-safe", "async", "tokio"]
 categories = ["asynchronous", "network-programming"]
-documentation = "https://docs.rs/irc/"
-repository = "https://github.com/aatxe/irc"
-readme = "README.md"
-edition = "2018"
 
 
 [badges]
@@ -23,9 +24,9 @@ members = [ "./", "irc-proto/" ]
 
 
 [features]
-default = ["ctcp", "tls-native", "toml_config"]
+default = ["ctcp", "tls-native", "channel-lists", "toml_config"]
 ctcp = []
-nochanlists = []
+channel-lists = []
 
 json_config = ["serde", "serde/derive", "serde_derive", "serde_json"]
 toml_config = ["serde", "serde/derive", "serde_derive", "toml"]
@@ -37,46 +38,47 @@ yaml = ["yaml_config"]
 proxy = ["tokio-socks"]
 
 tls-native = ["native-tls", "tokio-native-tls"]
-tls-rust = ["tokio-rustls", "webpki-roots"]
+tls-rust = ["tokio-rustls", "webpki-roots", "rustls-pemfile"]
 
 
 [dependencies]
-chrono = "0.4.0"
-encoding = "0.2.0"
-futures-util = { version = "0.3.0", default-features = false, features = ["alloc", "sink"] }
-irc-proto = { version = "0.14.0", path = "irc-proto" }
-log = "0.4.0"
-parking_lot = "0.11.0"
-thiserror = "1.0.0"
-pin-project = "1.0.2"
-tokio = { version = "1.0.0", features = ["net", "time", "sync"] }
-tokio-stream = "0.1.0"
-tokio-util = { version = "0.6.0", features = ["codec"] }
+chrono = { version = "0.4.24", default-features = false, features = ["clock", "std"] }
+encoding = "0.2.33"
+futures-util = { version = "0.3.30", default-features = false, features = ["alloc", "sink"] }
+irc-proto = { version = "1.0.0", path = "irc-proto" }
+log = "0.4.21"
+parking_lot = "0.12.1"
+thiserror = "1.0.58"
+pin-project = "1.0.12"
+tokio = { version = "1.27.0", features = ["net", "time", "sync"] }
+tokio-stream = "0.1.12"
+tokio-util = { version = "0.7.7", features = ["codec"] }
 
 # Feature - Config
-serde = { version = "1.0.0", optional = true }
-serde_derive = { version = "1.0.0", optional = true }
-serde_json = { version = "1.0.0", optional = true }
-serde_yaml = { version = "0.8.0", optional = true }
-toml = { version = "0.5.0", optional = true }
+serde = { version = "1.0.160", optional = true }
+serde_derive = { version = "1.0.160", optional = true }
+serde_json = { version = "1.0.95", optional = true }
+serde_yaml = { version = "0.9.21", optional = true }
+toml = { version = "0.7.3", optional = true }
 
 # Feature - Proxy
 tokio-socks = { version = "0.5.1", optional = true }
 
 # Feature - TLS
-native-tls = { version = "0.2.0", optional = true }
-tokio-rustls = { version = "0.22.0", optional = true }
-tokio-native-tls = { version = "0.3.0", optional = true }
-webpki-roots = { version = "0.20.0", optional = true }
+native-tls = { version = "0.2.11", optional = true }
+tokio-rustls = { version = "0.24.0", features = ["dangerous_configuration"], optional = true }
+rustls-pemfile = { version = "1.0.2", optional = true }
+tokio-native-tls = { version = "0.3.1", optional = true }
+webpki-roots = { version = "0.23.0", optional = true }
 
 
 [dev-dependencies]
-anyhow = "1.0.0"
-args = "2.0.0"
-env_logger = "0.7.0"
-futures = "0.3.0"
-getopts = "0.2.0"
-tokio = { version = "1.0.0", features = ["rt", "rt-multi-thread", "macros", "net", "time"] }
+anyhow = "1.0.81"
+args = "2.2.0"
+env_logger = "0.11.0"
+futures = "0.3.30"
+getopts = "0.2.21"
+tokio = { version = "1.27.0", features = ["rt", "rt-multi-thread", "macros", "net", "time"] }
 
 
 [[example]]

README.md

@@ -1,14 +1,14 @@
 # the irc crate [![Build Status][ci-badge]][ci] [![Crates.io][cr-badge]][cr] ![Downloads][dl-badge] [![Docs][doc-badge]][doc]
 
-[ci-badge]: https://travis-ci.org/aatxe/irc.svg?branch=stable
-[ci]: https://travis-ci.org/aatxe/irc
+[ci-badge]: https://github.com/aatxe/irc/actions/workflows/ci.yml/badge.svg
+[ci]: https://github.com/aatxe/irc/actions/workflows/ci.yml
 [cr-badge]: https://img.shields.io/crates/v/irc.svg
 [cr]: https://crates.io/crates/irc
 [dl-badge]: https://img.shields.io/crates/d/irc.svg
 [doc-badge]: https://docs.rs/irc/badge.svg
 [doc]: https://docs.rs/irc
 
-[rfc2812]: http://tools.ietf.org/html/rfc2812
+[rfc2812]: http://datatracker.ietf.org/doc/html/rfc2812
 [ircv3.1]: http://ircv3.net/irc/3.1.html
 [ircv3.2]: http://ircv3.net/irc/3.2.html
 
@@ -41,7 +41,7 @@ Making your own project? [Submit a pull request](https://github.com/aatxe/irc/pu
 
 ## Getting Started
 
-To start using the irc crate with cargo, you can add `irc = "0.13"` to your dependencies in
+To start using the irc crate with cargo, you can add `irc = "0.15"` to your dependencies in
 your Cargo.toml file. The high-level API can be found in [`irc::client::prelude`][irc-prelude].
 You'll find a number of examples to help you get started in `examples/`, throughout the
 documentation, and below.
@@ -62,7 +62,7 @@ async fn main() -> Result<(), failure::Error> {
     let config = Config {
         nickname: Some("the-irc-crate".to_owned()),
         server: Some("chat.freenode.net".to_owned()),
-        channels: Some(vec!["#test".to_owned()]),
+        channels: vec!["#test".to_owned()],
         ..Config::default()
     };
 
@@ -79,6 +79,22 @@ async fn main() -> Result<(), failure::Error> {
 }
 ```
 
+Example Cargo.toml file:
+```rust,no_run,edition2018
+[package]
+name = "example"
+version = "0.1.0"
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+irc = "0.15.0"
+tokio = { version = "1.0.0", features = ["rt", "rt-multi-thread", "macros", "net", "time"] }
+futures = "0.3.0"
+failure = "0.1.8"
+```
+
 ## Configuring IRC Clients
 
 As seen above, there are two techniques for configuring the irc crate: runtime loading and
@@ -120,7 +136,7 @@ user_info = "I'm a test user for the irc crate."
 version = "irc:git:Rust"
 source = "https://github.com/aatxe/irc"
 ping_time = 180
-ping_timeout = 10
+ping_timeout = 20
 burst_window_length = 8
 max_messages_in_burst = 15
 should_ghost = false

examples/build-bot.rs

@@ -27,23 +27,20 @@ async fn main() -> irc::error::Result<()> {
     let mut stream = client.stream()?;
 
     while let Some(message) = stream.next().await.transpose()? {
-        match message.command {
-            Command::Response(Response::RPL_ISUPPORT, _) => {
-                client.send_privmsg(
-                    "#commits",
-                    format!(
-                        "[{}/{}] ({}) {} [{}]",
-                        repository_slug,
-                        branch,
-                        &commit[..7],
-                        commit_message,
-                        features,
-                    ),
-                )?;
-
-                client.send_quit("QUIT")?;
-            }
-            _ => (),
+        if let Command::Response(Response::RPL_ISUPPORT, _) = message.command {
+            client.send_privmsg(
+                "#commits",
+                format!(
+                    "[{}/{}] ({}) {} [{}]",
+                    repository_slug,
+                    branch,
+                    &commit[..7],
+                    commit_message,
+                    features,
+                ),
+            )?;
+
+            client.send_quit("QUIT")?;
         }
     }
 

examples/multiserver.rs

@@ -45,13 +45,10 @@ async fn main() -> irc::error::Result<()> {
 fn process_msg(sender: &Sender, message: Message) -> error::Result<()> {
     print!("{}", message);
 
-    match message.command {
-        Command::PRIVMSG(ref target, ref msg) => {
-            if msg.contains("pickles") {
-                sender.send_privmsg(target, "Hi!")?;
-            }
+    if let Command::PRIVMSG(ref target, ref msg) = message.command {
+        if msg.contains("pickles") {
+            sender.send_privmsg(target, "Hi!")?;
         }
-        _ => (),
     }
 
     Ok(())

examples/repeater.rs

@@ -22,7 +22,7 @@ async fn main() -> irc::error::Result<()> {
         let message = stream.select_next_some().await?;
 
         if let Command::PRIVMSG(ref target, ref msg) = message.command {
-            if msg.starts_with(&*client.current_nickname()) {
+            if msg.starts_with(client.current_nickname()) {
                 let tokens: Vec<_> = msg.split(' ').collect();
                 if tokens.len() > 2 {
                     let n = tokens[0].len() + tokens[1].len() + 2;

examples/simple.rs

@@ -19,13 +19,10 @@ async fn main() -> irc::error::Result<()> {
     while let Some(message) = stream.next().await.transpose()? {
         print!("{}", message);
 
-        match message.command {
-            Command::PRIVMSG(ref target, ref msg) => {
-                if msg.contains(client.current_nickname()) {
-                    sender.send_privmsg(target, "Hi!")?;
-                }
+        if let Command::PRIVMSG(ref target, ref msg) = message.command {
+            if msg.contains(client.current_nickname()) {
+                sender.send_privmsg(target, "Hi!")?;
             }
-            _ => (),
         }
     }
 

examples/simple_plaintext.rs

@@ -20,13 +20,10 @@ async fn main() -> irc::error::Result<()> {
     while let Some(message) = stream.next().await.transpose()? {
         print!("{}", message);
 
-        match message.command {
-            Command::PRIVMSG(ref target, ref msg) => {
-                if msg.contains(client.current_nickname()) {
-                    sender.send_privmsg(target, "Hi!")?;
-                }
+        if let Command::PRIVMSG(ref target, ref msg) = message.command {
+            if msg.contains(client.current_nickname()) {
+                sender.send_privmsg(target, "Hi!")?;
             }
-            _ => (),
         }
     }
 

examples/simple_proxy.rs

@@ -22,13 +22,10 @@ async fn main() -> irc::error::Result<()> {
     while let Some(message) = stream.next().await.transpose()? {
         print!("{}", message);
 
-        match message.command {
-            Command::PRIVMSG(ref target, ref msg) => {
-                if msg.contains(client.current_nickname()) {
-                    sender.send_privmsg(target, "Hi!")?;
-                }
+        if let Command::PRIVMSG(ref target, ref msg) = message.command {
+            if msg.contains(client.current_nickname()) {
+                sender.send_privmsg(target, "Hi!")?;
             }
-            _ => (),
         }
     }
 

irc-proto/Cargo.toml

@@ -1,14 +1,15 @@
 [package]
 name = "irc-proto"
-version = "0.14.0"
-description = "The IRC protocol distilled."
+version = "1.0.0"
 authors = ["Aaron Weiss <aweiss@hey.com>"]
+edition = "2018"
+rust-version = "1.60"
+description = "The IRC protocol distilled."
+documentation = "https://docs.rs/irc-proto/"
+repository = "https://github.com/aatxe/irc"
 license = "MPL-2.0"
 keywords = ["irc", "protocol", "tokio"]
 categories = ["network-programming"]
-documentation = "https://docs.rs/irc-proto/"
-repository = "https://github.com/aatxe/irc"
-edition = "2018"
 
 [badges]
 travis-ci = { repository = "aatxe/irc" }
@@ -17,9 +18,9 @@ travis-ci = { repository = "aatxe/irc" }
 default = ["bytes", "tokio", "tokio-util"]
 
 [dependencies]
-encoding = "0.2.0"
-thiserror = "1.0.0"
+encoding = "0.2.33"
+thiserror = "1.0.40"
 
-bytes = { version = "1.0.0", optional = true }
-tokio = { version = "1.0.0", optional = true }
-tokio-util = { version = "0.6.0", features = ["codec"], optional = true }
+bytes = { version = "1.4.0", optional = true }
+tokio = { version = "1.27.0", optional = true }
+tokio-util = { version = "0.7.7", features = ["codec"], optional = true }