Replace bool with enum for a function parameter of label::fmt_string #1875
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 commit addresses code smell where the said function takes a bool to decide whether it percent-encodes the UTF-8 encoding of the given string. For clarity, we define an enum EncodingStrategy so that we can see the callers' intent at the call sites by reading the variant names rather than true/false.
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
jdisanti
reviewed
Oct 18, 2022
Co-authored-by: John DiSanti <[email protected]>
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
added 2 commits
October 19, 2022 14:15
This commit modifies a call site for the updated function signature of `aws_smithy_http::label::fmt_string`, otherwise the test would fail to compile, leading to a failure in CI.
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
hlbarber
approved these changes
Oct 20, 2022
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
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 and Context
Fixes #964
Description
This commit is a refactoring where the said function takes a
boolto decide whether it percent-encodes the UTF-8 encoding of/in the given string. For clarity, we define an enumEncodingStrategyso that we can better express the callers' intent at the call sites with the variant names rather thantrue/false.In addition, the PR includes two tangential changes:
label::fmt_timestampcallslabel::fmt_string(one in its own module) rather thanquery::fmt_string. I made this change with the intent that if some operation can be completed without reaching into another module, it's more self-contained. I'm open to opinions/suggestions/preferences as to whether we revert the change.BASE_SETis nowpub(crate)so that we don't need to export it from the crate.Testing
Ran
cargo tfromaws/rust-runtimeChecklist
CHANGELOG.next.tomlif I made changes to the smithy-rs codegen or runtime cratesBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.