feat(core): Introduce builder API for ClientOptions#1221
Open
szokeasaurusrex wants to merge 1 commit into
Open
feat(core): Introduce builder API for ClientOptions#1221szokeasaurusrex wants to merge 1 commit into
ClientOptions#1221szokeasaurusrex wants to merge 1 commit into
Conversation
|
231c26f to
7f5da56
Compare
7f5da56 to
4695ca0
Compare
Introduce a builder API as the preferred method for constructing `ClientOptions`. In the changelog, we note that the old construction method is deprecated, but unfortunately, this is the only deprecation notice; Rust does not give us a way to warn at compile time. As the builder methods are the new primary ways for setting things, we move the field documentation to the respective builder methods. Also, we make `ClientOptions` `#[must_use]` to ensure that folks use the options after building them. Resolves [#1220](#1220) Resolves [RUST-259](https://linear.app/getsentry/issue/RUST-259)
4695ca0 to
754109d
Compare
This file contains hidden or 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
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.
Introduce a builder API as the preferred method for constructing
ClientOptions. In the changelog, we note that the old construction method is deprecated, but unfortunately, this is the only deprecation notice; Rust does not give us a way to warn at compile time.As the builder methods are the new primary ways for setting things, we move the field documentation to the respective builder methods. Also, we make
ClientOptions#[must_use]to ensure that folks use the options after building them.Resolves #1220
Resolves RUST-259