add into_inner and similar methods to StreamFuture #722
Conversation
|
Thanks! Looks like CI may be failing? |
tdyas
force-pushed
the
into_inner_for_stream_future
branch
from
7c2a8a5 to
a072a1d
Compare
|
Pushed a fix. Helps if I had run |
|
Thanks! Could these functions actually return |
|
They could. That's an API design choice that is yours to make. From what I understand, the
Pushing the chance of panic to the developer seems like the better solution, although the fact that the stream is stored in an Option internally seems like an internal implementation detail of |
|
Yeah the convention so far that we're trying to stick to is to push the panics outwards, e.g. give you a chance to handle the case where the inner stream is gone. |
When selecting on a StreamFuture and other futures, it is useful to be able to recover the underlying Stream if one of the other futures resolves first. These methods return `Option` to account for the fact that `StreamFuture`'s implementation of `Future::poll` consumes the underlying stream during polling in order to return it to the caller of `Future::poll` if the stream yieleded an element.
tdyas
force-pushed
the
into_inner_for_stream_future
branch
from
a072a1d to
767df28
Compare
|
The latest change has the Option return types and applicable documentation. |
|
Thanks! |
| /// | ||
| /// This method returns an `Option` to account for the fact that `StreamFuture`'s | ||
| /// implementation of `Future::poll` consumes the underlying stream during polling | ||
| /// in order to return it to the caller of `Future::poll` if the stream yieleded |
When selecting on a StreamFuture and other futures, it is useful to be able to recover the underlying Stream if one of the other futures resolves first.
See #633 (comment) for more information.