#[instrument]: add ret(err, ok)
#2970
Open
+399
−260
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
#[instrument(ret)] emits an event for any return value, it has no visibility into the return type. #[instrument(err)] emits only Err values, there is no way to emit only Ok values.
Xiretza
force-pushed
the
instrument-ret-ok-err
branch
from
d29f90a
to
7f47ae7
Compare
Xiretza
force-pushed
the
instrument-ret-ok-err
branch
from
7f47ae7
to
77bb24e
Compare
|
Please let me know if there's anything I can do to ease review on this. Also, is |
I'll review now. Please keep this pointed at master; we'll handle backports. |
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.
As proposed in #2963 (comment).
Motivation
Okreturn values#[instrument(ret, err)]interface feels a little weird becausereteither means "any return value" or "theOkreturn value" depending on whethererris also presentSolution
This solution is fully backwards-compatible (i.e. the
#[instrument(ret, err)]syntax continues to work), but adds a more consistent interface using#[instrument(ret(ok(...), err(...)))]. As such, it could also be backported to the v0.1.x branch.Trying to use both syntaxes at the same time results in a compile error rather than weird behaviour.
I also cleaned up and fixed the documentation and tests while I was at it (best reviewed commit by commit).