Add length_field_type to LengthDelimitedCodec builder
#4508
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
Allows passing in the wanted unsigned integer type.
`u128` is analogous to `length_field_length(16)`, which would fail.
|
r? @hawkw |
hawkw
approved these changes
Feb 18, 2022
| /// .length_field_type::<u32>() | ||
| /// .new_read(io); | ||
| /// # } | ||
| /// # pub fn main() {} |
There was a problem hiding this comment.
my guess is that the fn main()s in these doctests are here because other functions in the module have them? AFAICT, they shouldn't actually be necessary; not a blocker though.
There was a problem hiding this comment.
Yeah I figured the same but wanted to just be consistent with the other doctests.
|
Thanks Eliza! r? @carllerche since you touched |
Darksonn
added
A-tokio-util
djc
approved these changes
Feb 21, 2022
Darksonn
reviewed
Feb 21, 2022
Comment on lines
+800
to
+801
| /// The default type is [`u32`]. The max type is [`u64`] (or [`usize`] on | ||
| /// 64-bit targets). |
There was a problem hiding this comment.
The compilation failure example uses u128.
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.
Like
length_field_lengthexcept you pass a compile-time checked unsigned integer type instead.Motivation
Powers of two are the most common values for
length_field_length, but passing in a number of bytes for these feels a bit awkward, especially when the docs state "parse au16length field".Solution
Add
length_field_typemethod that takes a generic type.Implement a sealed (public in private) trait for acceptable types, failing on bad types at compile-time (e.g.
i32,u128,String).