sync: expand oneshot docs and TryRecvError
#1874
Merged
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
`oneshot::Receiver::try_recv` does not provide any information as to the reason **why** receiving failed. The two cases are that the channel is empty or that the channel closed. `TryRecvError` is changed to be an enum of those two cases. This is backwards compatible as `TryRecvError` was an opaque struct. This also expands on `oneshot` API documentation, adding details and examples. Closes #1872
LucioFranco
approved these changes
Dec 1, 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.
oneshot::Receiver::try_recvdoes not provide any information as to thereason why receiving failed. The two cases are that the channel is
empty or that the channel closed.
TryRecvErroris changed to be an enum of those two cases. This isbackwards compatible as
TryRecvErrorwas an opaque struct.This also expands on
oneshotAPI documentation, adding details andexamples.
Closes #1872
cc @bIgBV