Small refactor in EnumGenerator.kt
#2097
Closed
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
Some Rust code blocks have been trivially made more uninterrupted and DRYer.
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
jjant
approved these changes
Dec 13, 2022
Comment on lines
225
to
247
| docs( | ||
| """ | ||
| Opaque struct used as inner data for the `Unknown` variant defined in enums in | ||
| the crate | ||
| the crate. | ||
|
|
||
| While this is not intended to be used directly, it is marked as `pub` because it is | ||
| part of the enums that are public interface. | ||
| """.trimIndent(), | ||
| """, | ||
| ) | ||
| meta.render(this) | ||
| rust("struct $UnknownVariantValue(pub(crate) String);") | ||
| rustBlock("impl $UnknownVariantValue") { | ||
| // The generated as_str is not pub as we need to prevent users from calling it on this opaque struct. | ||
| rustBlock("pub(crate) fn as_str(&self) -> &str") { | ||
| rust("&self.0") | ||
| // The generated `as_str` is not `pub` as we need to prevent users from calling it on this opaque struct. | ||
| rust( | ||
| """ | ||
| struct $UnknownVariantValue(pub(crate) String); | ||
| impl $UnknownVariantValue { | ||
| pub(crate) fn as_str(&self) -> &str { | ||
| &self.0 | ||
| } | ||
| } | ||
| } | ||
| """, | ||
| ) | ||
| } | ||
| } |
There was a problem hiding this comment.
Can this be written as this (the syntax might be slightly off)?
rustTemplate("""
/// Opaque struct used as inner data for the `Unknown` variant defined in enums in
/// the crate.
/// While this is not intended to be used directly, it is marked as `pub` because it is
/// part of the enums that are public interface.
#{Metadata:W}
struct $UnknownVariantValue(pub(crate) String);
impl $UnknownVariantValue {
pub(crate) fn as_str(&self) -> &str {
&self.0
}
}
""",
"Metadata" to meta::render
)
jdisanti
approved these changes
Dec 13, 2022
ysaito1001
approved these changes
Dec 14, 2022
| @@ -299,7 +309,7 @@ private fun RustWriter.renderForwardCompatibilityNote( | |||
| variant in a current version of SDK, your code should continue to work when you | |||
| upgrade SDK to a future version in which the enum does include a variant for that | |||
| feature. | |||
| """.trimIndent(), | |||
| """, | |||
There was a problem hiding this comment.
Interesting that trimIdent can be removed 🤔 I had to add it only because a pre-commit hook complained about it.
There was a problem hiding this comment.
I think they can always be removed, and perhaps the pre-commit hook error message is not clear/just wrong.
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
|
Closing because of staleness; these improvements were made in #2334. |
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.
Some Rust code blocks have been trivially made more uninterrupted and
DRYer.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.