Add #[must_use] to all async Future types#58
Open
ZXY595 wants to merge 1 commit into
Open
Conversation
Prevents silently dropping futures like tx.push(value) that look synchronous but return an unawaited future. All 8 custom Future types in AsyncProducer/AsyncConsumer traits are annotated.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Futures returned by
AsyncConsumer/AsyncProducermethods do nothing unless .await-ed. Mistakenly dropping a future can silently lose items or block forever.For example:
This line looks synchronous but actually returns a future, and there's no warning about this mistake.
This PR adds #[must_use] to:
PopFuturePopSliceFuturePopVecFutureWaitOccupiedFuturePushFuturePushSliceFuturePushIterFutureWaitVacantFutureThanks for this great crate —
async-ringbufhas been a pleasure to use!