Skip to content

Commit cc2b159

Browse files
committed
Document the new 'trace' feature.
1 parent b12b7f2 commit cc2b159

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

core/lib/src/lib.rs

+15-13
Original file line numberDiff line numberDiff line change
@@ -53,20 +53,21 @@
5353
//!
5454
//! ## Features
5555
//!
56-
//! To avoid compiling unused dependencies, Rocket gates certain features. With
57-
//! the exception of `http2`, all are disabled by default:
56+
//! To avoid compiling unused dependencies, Rocket feature-gates optional
57+
//! functionality, some enabled by default:
5858
//!
59-
//! | Feature | Description |
60-
//! |-----------------|---------------------------------------------------------|
61-
//! | `secrets` | Support for authenticated, encrypted [private cookies]. |
62-
//! | `tls` | Support for [TLS] encrypted connections. |
63-
//! | `mtls` | Support for verified clients via [mutual TLS]. |
64-
//! | `http2` | Support for HTTP/2 (enabled by default). |
65-
//! | `json` | Support for [JSON (de)serialization]. |
66-
//! | `msgpack` | Support for [MessagePack (de)serialization]. |
67-
//! | `uuid` | Support for [UUID value parsing and (de)serialization]. |
68-
//! | `tokio-macros` | Enables the `macros` feature in the exported `tokio` |
69-
//! | `http3-preview` | Experimental preview support for [HTTP/3]. |
59+
//! | Feature | Default? | Description |
60+
//! |-----------------|----------|---------------------------------------------------------|
61+
//! | `trace` | Yes | Enables the default Rocket tracing [subscriber]. |
62+
//! | `http2` | Yes | Support for HTTP/2 (enabled by default). |
63+
//! | `secrets` | No | Support for authenticated, encrypted [private cookies]. |
64+
//! | `tls` | No | Support for [TLS] encrypted connections. |
65+
//! | `mtls` | No | Support for verified clients via [mutual TLS]. |
66+
//! | `json` | No | Support for [JSON (de)serialization]. |
67+
//! | `msgpack` | No | Support for [MessagePack (de)serialization]. |
68+
//! | `uuid` | No | Support for [UUID value parsing and (de)serialization]. |
69+
//! | `tokio-macros` | No | Enables the `macros` feature in the exported `tokio` |
70+
//! | `http3-preview` | No | Experimental preview support for [HTTP/3]. |
7071
//!
7172
//! Disabled features can be selectively enabled in `Cargo.toml`:
7273
//!
@@ -82,6 +83,7 @@
8283
//! rocket = { version = "0.6.0-dev", default-features = false }
8384
//! ```
8485
//!
86+
//! [subscriber]: crate::trace::subscriber
8587
//! [JSON (de)serialization]: crate::serde::json
8688
//! [MessagePack (de)serialization]: crate::serde::msgpack
8789
//! [UUID value parsing and (de)serialization]: crate::serde::uuid

0 commit comments

Comments
 (0)