io: read/write big-endian numbers #1863
Merged
Conversation
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
Provide convenience methods for encoding and decoding big-endian numbers on top of asynchronous I/O streams. Only primitive types are provided (24 and 48 bit numbers are omitted). In general, using these methods won't be the fastest way to do encoding/decoding with asynchronous byte streams, but they help to get simple things working fast.
jonhoo
reviewed
Nov 30, 2019
| }; | ||
| ($name:ident, $ty:ty, $reader:ident, $bytes:expr) => { | ||
| pin_project! { | ||
| #[doc(hidden)] |
There was a problem hiding this comment.
These doc(hidden) make me sad, since they mean the user can't even see that the return type is impl Future.
There was a problem hiding this comment.
I’m fine exposing more types, but this reminds me that I’ve been adding an “equivalent” async fn definition in docs.
There was a problem hiding this comment.
I'm hesitant to re-export futures as, in theory, one day we will be able to use real async fn here.
That said, since it is 0.2, we can re-export them for now.
jonhoo
approved these changes
Nov 30, 2019
|
I updated the docs to include an "equivalent async fn" |
LucioFranco
approved these changes
Nov 30, 2019
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.
Provide convenience methods for encoding and decoding big-endian numbers
on top of asynchronous I/O streams. Only primitive types are provided
(24 and 48 bit numbers are omitted).
In general, using these methods won't be the fastest way to do
encoding/decoding with asynchronous byte streams, but they help to get
simple things working fast.