fix: correct SerializeField definition #3040
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
Clippy in 1.80.0 alerted us to the fact that `SerializeField` was never constructed (and due to its non-`pub` member, it can't be constructed outside the `tracing-serde` crate where it's from). This change fixes the definition to hold a reference to a `Field`, which is what the other `Serialize*` types do. It also implements `AsSerde` for this type and uses it inside the `SerializeFieldSet` type. As a bonus, Clippy is now also happy that the type is constructed. The example collector in the `tracing-serde` crate was also renamed from `JsonSubscriber` to `JsonCollector`. Some additional doc formatting issues in `tracing-subscriber` were fixed so that list items that run to multiple lines are correctly indented.
hds
force-pushed
the
hds/tracing-serde-serialize-field-fix
branch
from
5776262 to
cfa24f8
Compare
davidbarsky
approved these changes
Jul 29, 2024
20 tasks
hds
added a commit
that referenced
this pull request
Nov 22, 2024
Clippy in 1.80.0 alerted us to the fact that `SerializeField` was never constructed (and due to its non-`pub` member, it can't be constructed outside the `tracing-serde` crate where it's from). This change fixes the definition to hold a reference to a `Field`, which is what the other `Serialize*` types do. It also implements `AsSerde` for this type and uses it inside the `SerializeFieldSet` type. As a bonus, Clippy is now also happy that the type is constructed. The example collector in the `tracing-serde` crate was also renamed from `JsonSubscriber` to `JsonCollector`. Some additional doc formatting issues in `tracing-subscriber` were fixed so that list items that run to multiple lines are correctly indented.
hds
added a commit
that referenced
this pull request
Nov 22, 2024
Clippy in 1.80.0 alerted us to the fact that `SerializeField` was never constructed (and due to its non-`pub` member, it can't be constructed outside the `tracing-serde` crate where it's from). This change fixes the definition to hold a reference to a `Field`, which is what the other `Serialize*` types do. It also implements `AsSerde` for this type and uses it inside the `SerializeFieldSet` type. As a bonus, Clippy is now also happy that the type is constructed. The example collector in the `tracing-serde` crate was also renamed from `JsonSubscriber` to `JsonCollector`. Some additional doc formatting issues in `tracing-subscriber` were fixed so that list items that run to multiple lines are correctly indented.
hds
added a commit
that referenced
this pull request
Nov 27, 2024
# 0.2.0 (November 27, 2024) [ [crates.io][crate-0.2.0] ] | [ [docs.rs][docs-0.2.0] ] <a id = "0.2.0-breaking"></a> ### Breaking Changes - Correct SerializeField definition and doc formatting ([#3040]) `SerializeField` has gained a generic lifetime parameter. ### Fixed - Implement `AsSerde` for `FieldSet` ([#2241]) - [**breaking**](#0.2.0-breaking) Correct SerializeField definition and doc formatting ([#3040]) ### Changed - Bump MSRV to 1.63 ([#2793]) [#2241]: #2241 [#3040]: #3040 [docs-0.2.0]: https://docs.rs/tracing-serde/0.2.0/tracing-serde/ [crate-0.2.0]: https://crates.io/crates/tracing-serde/0.2.0
hds
added a commit
that referenced
this pull request
Nov 27, 2024
# 0.2.0 (November 27, 2024) [ [crates.io][crate-0.2.0] ] | [ [docs.rs][docs-0.2.0] ] <a id = "0.2.0-breaking"></a> ### Breaking Changes - Correct SerializeField definition and doc formatting ([#3040]) `SerializeField` has gained a generic lifetime parameter. ### Fixed - Implement `AsSerde` for `FieldSet` ([#2241]) - [**breaking**](#0.2.0-breaking) Correct SerializeField definition and doc formatting ([#3040]) ### Changed - Bump MSRV to 1.63 ([#2793]) [#2241]: #2241 [#3040]: #3040 [docs-0.2.0]: https://docs.rs/tracing-serde/0.2.0/tracing-serde/ [crate-0.2.0]: https://crates.io/crates/tracing-serde/0.2.0
# for free
to join this conversation on GitHub.
Already have an account?
# 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
Clippy in 1.80.0 alerted us to the fact that
SerializeFieldwas neverconstructed (and due to its non-
pubmember, it can't be constructedoutside the
tracing-serdecrate where it's from).Solution
This change fixes the definition to hold a reference to a
Field, whichis what the other
Serialize*types do. It also implementsAsSerdefor this type and uses it inside the
SerializeFieldSettype.As a bonus, Clippy is now also happy that the type is constructed.
The example collector in the
tracing-serdecrate was also renamed fromJsonSubscribertoJsonCollector.