fix-or-feat(iroh): Set MaybeFuture to None on Poll::Ready #3090
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
This removes a footgun where after polling the future it is easy to forget to call MaybeFuture::set_none, which can result in a failure if the inner future is not fused.
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/3090/docs/iroh/ Last updated: 2025-01-03T09:58:59Z |
dignifiedquire
approved these changes
Jan 3, 2025
rklaehn
reviewed
Jan 3, 2025
| }; | ||
| match poll_res { | ||
| Poll::Ready(val) => { | ||
| self.as_mut().project_replace(Self::None); |
There was a problem hiding this comment.
project_replace... how are you supposed to keep these APIs in your head...
There was a problem hiding this comment.
You don't: you post a challenge in the rust channel on discord and @dignifiedquire will figures it out 😛
Alternatively you try to use pin-project on an enum, discover this blows up and go read the docs.
rklaehn
approved these changes
Jan 3, 2025
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.
Description
This removes a footgun where after polling the future it is easy to
forget to call MaybeFuture::set_none, which can result in a panic if
the inner future is not fused.
Breaking Changes
Notes & open questions
Change checklist