Add read_from_packed_stream to make reading individual packed messages easier
#33
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
|
Wooo |
mikea
approved these changes
Nov 6, 2024
| /// Read a message from a `PackedStream`. This allows you to continue reading more packed | ||
| /// data after the stream and reuse the packed state. | ||
| #[cfg(feature = "std")] | ||
| pub fn read_with_packed_stream<R: io::BufRead>( |
There was a problem hiding this comment.
I find name difference very insignificant and as a result I have no idea which one to use based on the name.
Can we differentiate these two more? Maybe with doesn't need to be pub?
There was a problem hiding this comment.
The intention is that "with" implies you're using an existing thing, "from" implies you're consuming the thing completely. "with" needs to be pub because you could have a stream of multiple packed messages or general packed data. You want to keep the PackedStream state around so you can read more stuff.
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.
In practice, having to make a
PackedStream, callread_packed_from_stream, then call.finish()on the stream just to read a single message is really annoying. It's useful to have it be separate, but reading a single self-contained message from a stream (like a slice or something similar) is pretty common. So this changes the API slightly to make reading a single message easy.