subscriber: move fmt::LayerBuilder methods to fmt::Layer
#655
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
There isn't an actual reason that `fmt::Layer` needs a separate builder type, since the builder and layer structs are identical and only differ in what methods they provide. If the methods for configuring a `Layer` were exposed by the `Layer` type instead, it would be simple to construct `Layer`s — no need to call `.finish()` on the builder. This commit moves all the `LayerBuilder` methods to `Layer`, makes `LayerBuilder` a type alias for `Layer`, and deprecates `Layer::builder`, the `LayerBuilder` type, and `LayerBuilder::finish()`. Since nothing has been removed, this shouldn't be a breaking change, but we can remove the deprecated APIs in 0.3.x. Signed-off-by: Eliza Weisman <eliza@buoyant.io>
davidbarsky
approved these changes
Apr 2, 2020
hawkw
added a commit
that referenced
this pull request
Apr 6, 2020
# 0.2.4 (April 6, 2020) This release includes several API ergonomics improvements, including shorthand constructors for many types, and an extension trait for initializing subscribers using method-chaining style. Additionally, several bugs in less commonly used `fmt` APIs were fixed. ### Added - **fmt**: Shorthand free functions for constructing most types in `fmt` (including `tracing_subscriber::fmt()` to return a `SubscriberBuilder`, `tracing_subscriber::fmt::layer()` to return a format `Layer`, etc) (#660) - **registry**: Shorthand free function `tracing_subscriber::registry()` to construct a new registry (#660) - Added `SubscriberInitExt` extension trait for more ergonomic subscriber initialization (#660) ### Changed - **fmt**: Moved `LayerBuilder` methods to `Layer` (#655) ### Deprecated - **fmt**: `LayerBuilder`, as `Layer` now implements all builder methods (#655) ### Fixed - **fmt**: Fixed `Compact` formatter not omitting levels with `with_level(false)` (#657) - **fmt**: Fixed `fmt::Layer` duplicating the fields for a new span if another layer has already formatted its fields (#634) - **fmt**: Added missing space when using `record` to add new fields to a span that already has fields (#659) - Updated outdated documentation (#647) Signed-off-by: Eliza Weisman <eliza@buoyant.io>
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
There isn't an actual reason that
fmt::Layerneeds a separate buildertype, since the builder and layer structs are identical and only differ
in what methods they provide. If the methods for configuring a
Layerwere exposed by the
Layertype instead, it would be simple toconstruct
Layers — no need to call.finish()on the builder.Solution
This commit moves all the
LayerBuildermethods toLayer, makesLayerBuildera type alias forLayer, and deprecatesLayer::builder, theLayerBuildertype, andLayerBuilder::finish().Since nothing has been removed, this shouldn't be a breaking change, but
we can remove the deprecated APIs in 0.3.x.
Signed-off-by: Eliza Weisman eliza@buoyant.io