subscriber: fix accessing the field formatter from FmtContext
#1082
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
This backports PR #1081 from v0.2.x. Motivation Currently, the `FmtContext` type implements `FormatFields` using the subscriber's field formatter. However, this is difficult to use. The `FmtContext` may _not_ be passed to functions expecting a `for<'writer> FormatFields<'writer>`, because it only implements `FormatFields` for its _own_ lifetime. This means the writer must have the same lifetime as the context, which is not correct. Solution This branch fixes this by changing the impl of `FormatFields` for `FmtContext` to be generic over both the context's lifetime _and_ the field formatter's lifetime. Additionally, I've added a method for borrowing the actual field formatter as its concrete type, in case the `FormatEvent` impl puts additional constraints on its type or is only implemented for a specific named type, and wants to actually _use_ that type.
hawkw
added a commit
that referenced
this pull request
Nov 2, 2020
Fixed - **fmt**: Fixed wrong lifetime parameters on `FormatFields` impl for `FmtContext` ([#1082]) Added - **fmt**: `format::Pretty`, an aesthetically pleasing, human-readable event formatter for local development and user-facing CLIs ([#1080]) - **fmt**: `FmtContext::field_format`, which returns the subscriber's field formatter ([#1082]) [#1082]: #1082 [#1080]: #1080
hawkw
added a commit
that referenced
this pull request
Nov 2, 2020
### Fixed - **fmt**: Fixed wrong lifetime parameters on `FormatFields` impl for `FmtContext` ([#1082]) ### Added - **fmt**: `format::Pretty`, an aesthetically pleasing, human-readable event formatter for local development and user-facing CLIs ([#1080]) - **fmt**: `FmtContext::field_format`, which returns the subscriber's field formatter ([#1082]) [#1082]: #1082 [#1080]: #1080
kaffarell
pushed a commit
to kaffarell/tracing
that referenced
this pull request
May 22, 2024
…o-rs#1081) (tokio-rs#1082) This backports PR tokio-rs#1081 from v0.2.x. Since this has already been approved on master, I'll just go ahead and merge it when CI passes. ## Motivation Currently, the `FmtContext` type implements `FormatFields` using the subscriber's field formatter. However, this is difficult to use. The `FmtContext` may _not_ be passed to functions expecting a `for<'writer> FormatFields<'writer>`, because it only implements `FormatFields` for its _own_ lifetime. This means the writer must have the same lifetime as the context, which is not correct. ## Solution This branch fixes this by changing the impl of `FormatFields` for `FmtContext` to be generic over both the context's lifetime _and_ the field formatter's lifetime. Additionally, I've added a method for borrowing the actual field formatter as its concrete type, in case the `FormatEvent` impl puts additional constraints on its type or is only implemented for a specific named type, and wants to actually _use_ that type.
kaffarell
pushed a commit
to kaffarell/tracing
that referenced
this pull request
May 22, 2024
### Fixed - **fmt**: Fixed wrong lifetime parameters on `FormatFields` impl for `FmtContext` ([tokio-rs#1082]) ### Added - **fmt**: `format::Pretty`, an aesthetically pleasing, human-readable event formatter for local development and user-facing CLIs ([tokio-rs#1080]) - **fmt**: `FmtContext::field_format`, which returns the subscriber's field formatter ([tokio-rs#1082]) [tokio-rs#1082]: tokio-rs#1082 [tokio-rs#1080]: tokio-rs#1080
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.
This backports PR #1081 from v0.2.x. Since this has already been approved
on master, I'll just go ahead and merge it when CI passes.
Motivation
Currently, the
FmtContexttype implementsFormatFieldsusing thesubscriber's field formatter. However, this is difficult to use. The
FmtContextmay not be passed to functions expecting afor<'writer> FormatFields<'writer>, because it only implementsFormatFieldsforits own lifetime. This means the writer must have the same lifetime as
the context, which is not correct.
Solution
This branch fixes this by changing the impl of
FormatFieldsforFmtContextto be generic over both the context's lifetime and thefield formatter's lifetime. Additionally, I've added a method for
borrowing the actual field formatter as its concrete type, in case the
FormatEventimpl puts additional constraints on its type or is onlyimplemented for a specific named type, and wants to actually use that
type.