misc: add feature flag to enable rustls logging (on by default)

crazyscot · Dec 26, 2024 · 4ac1774 · 4ac1774
1 parent 4d14a26
commit 4ac1774
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -19,6 +19,11 @@ split-debuginfo="unpacked"
 lto = "thin"
 strip = "symbols"
 
+[features]
+default = ["rustls-log"]
+## Enables rustls debug messages. You still have to request them using the environment variable, e.g. `RUST_LOG="rustls=debug"`.
+rustls-log = ["quinn/rustls-log"]
+
 [dependencies]
 anstream = "0.6.18"
 anstyle = "1.0.10"
@@ -31,6 +36,7 @@ console = "0.15.8"
 derive-deftly = "0.14.2"
 dirs = "5.0.1"
 dns-lookup = "2.0.4"
+document-features = "0.2.10"
 expanduser = "1.2.2"
 figment = { version = "0.10.19" }
 futures-util = { version = "0.3.31", default-features = false }

diff --git a/src/lib.rs b/src/lib.rs
@@ -71,6 +71,9 @@
 //! [BitTorrent]: https://en.wikipedia.org/wiki/BitTorrent
 //! [rsync]: https://en.wikipedia.org/wiki/Rsync
 //! [mosh]: https://mosh.org/
+//!
+//! ## Feature flags
+#![doc = document_features::document_features!()]
 
 mod cli;
 pub use cli::cli; // needs to be re-exported for the binary crate