Make reason for try_send errors clearer #864
Merged
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.
When you call
try_send
on a channel and the call fails, it often matters to the caller why the call failed. For unbounded senders, we know that it must be because the receiver went away, whereas for bounded channels it may either be because the receiver went away or because there was no available capacity. This PR explicitly calls out in the docs that errors onUnboundedSender::try_send
can only occur if the channel receiver has gone away, and addswas_closed
andwas_full
methods to the error returned byBoundedSender::try_send
so the caller can figure out which of the two error cases they're in.