sync: document that const_new() is not instrumented
#6002
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Darksonn
approved these changes
Sep 12, 2023
|
There are several instances on this on other synchronization primitives. |
The mutex created by `Mutex::const_new()` does not contain the tracing instrumentation that drives `tokio-console`. The same is true of `Notify`, `OnceCell` (including `const_new_with()`), `RwLock`, and `Semaphore`. This change adds documentation to each of the `const_*` constructors, explaining that objects created this way will not be instrumented and therefore will not appear in `tokio-console`. A link to the non-const variant is provided in each case.
c4449e8
to
88d5c3d
Compare
Mutex::const_new() is not instrumentedconst_new() is not instrumented
|
@Darksonn I don't know why I thought Thanks for pointing that out. I've updated all the others I could find. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The mutex created by
Mutex::const_new()does not contain the tracinginstrumentation that drives
tokio-console.The same is true of
Notify,OnceCell(includingconst_new_with()),RwLock, andSemaphore.Solution
This change adds documentation to each of the
const_*constructors,explaining that objects created this way will not be instrumented and
therefore will not appear in
tokio-console. A link to the non-constvariant is provided in each case.