itsscb/tracing
1
0
Fork 0
mirror of https://github.com/tokio-rs/tracing.git synced 2026-04-13 20:54:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: recommend configuring await-holding-invalid-types lint (#3463)

Browse Source 
## Motivation

Holding a span entered guard across `.await`
points can lead to incorrect behavior.


## Solution

Adds documentation recommending the `clippy::await_holding_invalid_type`
lint configuration to help users detect when `Entered`
or `EnteredSpan` guards are held across `.await`
points.

Fixes: #3408
This commit is contained in:
WaterWhisperer
2026-04-01 17:31:18 +08:00
committed by GitHub
parent 9545be16f5
commit 72cf52a9e2
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
tracing/src/span.rs
View File

@@ -718,10 +718,24 @@ impl Span {
/// }
/// ```
///
/// Additionally, the [`clippy::await_holding_invalid_type`] lint may be
/// used to detect cases where code holds a span guard across an `.await`
/// point. By adding the following to a `clippy.toml` file at the root of a
/// crate, `clippy` will automatically warn when the `Entered` or
/// `EnteredSpan` guards are held across an await point:
///
/// ```toml
/// await-holding-invalid-types = [
/// { path = "tracing::span::Entered", reason = "spans must be entered and exited on the same thread, entered guards should not be held across '.await' points" },
/// { path = "tracing::span::EnteredSpan", reason = "spans must be entered and exited on the same thread, entered guards should not be held across '.await' points" },
/// ]
/// ```
///
/// [syntax]: https://rust-lang.github.io/async-book/01_getting_started/04_async_await_primer.html
/// [`Span::in_scope`]: Span::in_scope()
/// [instrument]: crate::Instrument
/// [attr]: macro@crate::instrument
/// [`clippy::await_holding_invalid_type`]: https://rust-lang.github.io/rust-clippy/master/index.html#/await_holding_invalid_type
///
/// # Examples
///