Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sync: document that const_new() is not instrumented #6002

Merged
merged 1 commit into from Sep 13, 2023

Commits on Sep 13, 2023

  1. sync: document that const_new() is not instrumented

    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.
    hds committed Sep 13, 2023
    Configuration menu
    Copy the full SHA
    88d5c3d View commit details
    Browse the repository at this point in the history