Merge branch 'twilight-rs:main' into main

Author: roberts-pumpurs

.github/ISSUE_TEMPLATE/config.yml

@@ -1,4 +1,4 @@
 contact_links:
-    - name: Support Server
-      url: https://discord.gg/7jj8n7D
-      about: Ask a question here before making an issue, if possible.
+  - name: Support Server
+    url: https://discord.gg/twilight-rs
+    about: Ask a question here before making an issue, if possible.

.github/workflows/check.yml

@@ -80,6 +80,8 @@ jobs:
 
       - name: Install stable toolchain
         uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy
 
       - name: Cache dependencies
         uses: Swatinem/rust-cache@v2
@@ -110,10 +112,9 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install nightly toolchain
-        uses: dtolnay/rust-toolchain@v1
+        uses: dtolnay/rust-toolchain@nightly
         with:
           components: rustfmt
-          toolchain: nightly
 
       - name: Add problem matchers
         run: echo "::add-matcher::.github/rust.json"

Cargo.toml

@@ -18,8 +18,8 @@ resolver = "2"
 
 [workspace.package]
 authors = ["Twilight Contributors"]
-edition = "2021"
+edition = "2024"
 include = ["src/**/*.rs", "README.md"]
 license = "ISC"
 repository = "https://github.com/twilight-rs/twilight.git"
-rust-version = "1.79"
+rust-version = "1.89"

README.md

@@ -16,7 +16,7 @@ functionality. Please use the individual crates listed below instead!
 
 ## Installation
 
-Twilight supports a MSRV of Rust 1.79. We do not consider changes to the MSRV
+Twilight supports a MSRV of Rust 1.89. We do not consider changes to the MSRV
 semver-incompatible, therefore it may change in minor or patch releases.
 
 We recommend that most users start out with these crates:
@@ -115,7 +115,7 @@ The following example is a template for bootstrapping a new bot using
 Twilight's HTTP and gateway clients with its in-memory cache. In order to
 run this, replace the contents of a new project's `main.rs` file with the
 following. Be sure to set the `DISCORD_TOKEN` environment variable to your
-bot's token. You must also depend on `tokio`, `twilight-cache-inmemory`,
+bot's token. You must also depend on `rustls`, `tokio`, `twilight-cache-inmemory`,
 `twilight-gateway`, `twilight-http`, and `twilight-model` in your `Cargo.toml`.
 
 ```rust,no_run
@@ -129,6 +129,9 @@ async fn main() -> anyhow::Result<()> {
     // Initialize the tracing subscriber.
     tracing_subscriber::fmt::init();
 
+    // Select rustls backend
+    rustls::crypto::ring::default_provider().install_default().unwrap();
+
     let token = env::var("DISCORD_TOKEN")?;
 
     // Use intents to only receive guild message events.

book/src/chapter_1_crates/section_2_http.md

@@ -59,6 +59,9 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
     // Initialize the tracing subscriber.
     tracing_subscriber::fmt::init();
 
+    // Select rustls backend
+    rustls::crypto::ring::default_provider().install_default().unwrap();
+
     let client = Client::new(env::var("DISCORD_TOKEN")?);
 
     let me = client.current_user().await?.model().await?;

book/src/chapter_1_crates/section_3_gateway.md

@@ -58,27 +58,17 @@ This is enabled by default.
 The `rustls-webpki-roots` feature enables [`tokio-websockets`]'
 `rustls-webpki-roots` feature.
 
-### Compression
+### Transport compression
 
 `twilight-gateway` supports both Zlib and Zstandard transport compression.
 
-#### Zlib (deprecated)
+#### Zlib
 
-Zlib allows specifying two different backends.
+The `zlib` feature implementation is `target_arch` dependent:
 
-##### Stock
-
-The `zlib-stock` feature makes [flate2] use of the stock Zlib which is either
-upstream or the one included with the operating system.
-
-##### SIMD
-
-`zlib-simd` enables the use of [zlib-ng] which is a modern fork of zlib that in
-most cases will be more effective. However, this will add an external dependency
-on [cmake].
-
-If both are enabled or if the `zlib` feature of [flate2] is enabled anywhere in
-the dependency tree it will make use of that instead of [zlib-ng].
+| s390x           | other       |
+| --------------- | ----------- |
+| [`zlib-ng-sys`] | [`zlib-rs`] |
 
 #### Zstandard
 
@@ -99,6 +89,9 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
     // Initialize the tracing subscriber.
     tracing_subscriber::fmt::init();
 
+    // Select rustls backend
+    rustls::crypto::ring::default_provider().install_default().unwrap();
+
     let token = env::var("DISCORD_TOKEN")?;
     let intents = Intents::GUILD_MESSAGES;
     let mut shard = Shard::new(ShardId::ONE, token, intents);
@@ -128,11 +121,10 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
 
 [img:shard]: ./section_3_shard.png
 [RusTLS]: https://crates.io/crates/rustls
-[cmake]: https://cmake.org/
-[flate2]: https://github.com/alexcrichton/flate2-rs
-[zlib-ng]: https://github.com/zlib-ng/zlib-ng
 [`hyper-rustls`]: https://crates.io/crates/hyper-rustls
 [`hyper-tls`]: https://crates.io/crates/hyper-tls
 [`serde_json`]: https://crates.io/crates/serde_json
 [`simd-json`]: https://crates.io/crates/simd-json
 [`tokio-websockets`]: https://crates.io/crates/tokio-websockets
+[`zlib-ng-sys`]: https://crates.io/crates/libz-ng-sys
+[`zlib-rs`]: https://crates.io/crates/zlib-rs

book/src/chapter_1_crates/section_7_first_party/section_3_lavalink.md

@@ -61,6 +61,12 @@ use twilight_lavalink::Lavalink;
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
+    // Initialize the tracing subscriber.
+    tracing_subscriber::fmt::init();
+
+    // Select rustls backend
+    rustls::crypto::ring::default_provider().install_default().unwrap();
+
     let token = env::var("DISCORD_TOKEN")?;
     let lavalink_host = SocketAddr::from_str(&env::var("LAVALINK_HOST")?)?;
     let lavalink_auth = env::var("LAVALINK_AUTHORIZATION")?;

book/src/support.md

@@ -15,7 +15,7 @@ The API documentation is [also available][api docs].
 
 ### Supported Rust Versions
 
-Twilight currently supports an MSRV of Rust 1.53+.
+Twilight currently supports an MSRV of Rust 1.89.
 
 ### Breaking Changes
 

examples/Cargo.toml

@@ -9,16 +9,17 @@ version = "0.0.0"
 anyhow = { default-features = false, features = ["std"], version = "1" }
 ed25519-dalek = "2"
 futures-util = { default-features = false, version = "0.3" }
-tokio-stream = { default-features = false, version = "0.1" }
 hex = "0.4"
 http-body-util = "0.1"
 hyper = { features = ["server"], version = "1" }
 hyper-util = { features = ["http1", "client-legacy"], version = "0.1" }
 log = { default-features = false, version = "0.4" }
 once_cell = "1.4"
+rustls = { default-features = false, features = ["ring"], version = "0.23" }
 serde = { version = "1", features = ["derive"] }
 serde_json = { version = "1" }
 tokio = { default-features = false, features = ["macros", "signal", "rt-multi-thread"], version = "1.0" }
+tokio-stream = { default-features = false, version = "0.1" }
 tokio-util = "0.7"
 tracing = "0.1"
 tracing-subscriber = { default-features = false, features = ["fmt", "tracing-log"], version = "0.3" }

examples/cache-optimization/main.rs

@@ -12,6 +12,11 @@ mod models;
 async fn main() -> anyhow::Result<()> {
     tracing_subscriber::fmt::init();
 
+    // Select rustls backend
+    rustls::crypto::ring::default_provider()
+        .install_default()
+        .unwrap();
+
     let event_types = EventTypeFlags::MESSAGE_CREATE
         | EventTypeFlags::GUILD_CREATE
         | EventTypeFlags::GUILD_UPDATE