Struct futures::stream::StreamFuture [−][src]
#[must_use = "futures do nothing unless polled"]pub struct StreamFuture<St> { /* fields omitted */ }
A combinator used to temporarily convert a stream into a future.
This future is returned by the Stream::into_future method.
Methods
impl<St> StreamFuture<St> where
St: Unpin + Stream, [src]
impl<St> StreamFuture<St> where
St: Unpin + Stream, pub fn get_ref(&self) -> Option<&St>[src]
pub fn get_ref(&self) -> Option<&St>Acquires a reference to the underlying stream that this combinator is pulling from.
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 yielded
an element.
pub fn get_mut(&mut self) -> Option<&mut St>[src]
pub fn get_mut(&mut self) -> Option<&mut St>Acquires a mutable reference to the underlying stream that this combinator is pulling from.
Note that care must be taken to avoid tampering with the state of the stream which may otherwise confuse this combinator.
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 yielded
an element.
pub fn into_inner(self) -> Option<St>[src]
pub fn into_inner(self) -> Option<St>Consumes this combinator, returning the underlying stream.
Note that this may discard intermediate state of this combinator, so care should be taken to avoid losing resources when this is called.
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 yielded
an element.
Trait Implementations
impl<St> Debug for StreamFuture<St> where
St: Debug, [src]
impl<St> Debug for StreamFuture<St> where
St: Debug, fn fmt(&self, f: &mut Formatter) -> Result<(), Error>[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>Formats the value using the given formatter. Read more
impl<St> Future for StreamFuture<St> where
St: Unpin + Stream, [src]
impl<St> Future for StreamFuture<St> where
St: Unpin + Stream, type Output = (Option<<St as Stream>::Item>, St)
🔬 This is a nightly-only experimental API. (futures_api)
futures in libcore are unstable
The result of the Future.
fn poll(
self: PinMut<StreamFuture<St>>,
cx: &mut Context
) -> Poll<<StreamFuture<St> as Future>::Output>[src]
fn poll(
self: PinMut<StreamFuture<St>>,
cx: &mut Context
) -> Poll<<StreamFuture<St> as Future>::Output>🔬 This is a nightly-only experimental API. (futures_api)
futures in libcore are unstable
Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more
impl<St> Unpin for StreamFuture<St> where
St: Unpin + Stream, [src]
impl<St> Unpin for StreamFuture<St> where
St: Unpin + Stream, Auto Trait Implementations
impl<St> Send for StreamFuture<St> where
St: Send,
impl<St> Send for StreamFuture<St> where
St: Send, impl<St> Sync for StreamFuture<St> where
St: Sync,
impl<St> Sync for StreamFuture<St> where
St: Sync, Blanket Implementations
impl<T> From for T[src]
impl<T> From for Timpl<T, U> TryFrom for T where
T: From<U>, [src]
impl<T, U> TryFrom for T where
T: From<U>, type Error = !
try_from)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>try_from)Performs the conversion.
impl<T, U> TryInto for T where
U: TryFrom<T>, [src]
impl<T, U> TryInto for T where
U: TryFrom<T>, type Error = <U as TryFrom<T>>::Error
try_from)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>try_from)Performs the conversion.
impl<T, U> Into for T where
U: From<T>, [src]
impl<T, U> Into for T where
U: From<T>, impl<T> Borrow for T where
T: ?Sized, [src]
impl<T> Borrow for T where
T: ?Sized, ⓘImportant traits for &'a mut Ifn borrow(&self) -> &T[src]
fn borrow(&self) -> &TImmutably borrows from an owned value. Read more
impl<T> BorrowMut for T where
T: ?Sized, [src]
impl<T> BorrowMut for T where
T: ?Sized, ⓘImportant traits for &'a mut Ifn borrow_mut(&mut self) -> &mut T[src]
fn borrow_mut(&mut self) -> &mut TMutably borrows from an owned value. Read more
impl<T> Any for T where
T: 'static + ?Sized, [src]
impl<T> Any for T where
T: 'static + ?Sized, fn get_type_id(&self) -> TypeId[src]
fn get_type_id(&self) -> TypeId🔬 This is a nightly-only experimental API. (get_type_id)
this method will likely be replaced by an associated static
Gets the TypeId of self. Read more
impl<T> FutureExt for T where
T: Future + ?Sized, [src]
impl<T> FutureExt for T where
T: Future + ?Sized, fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U, [src]
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U, Map this future's output to a different type, returning a new future of the resulting type. Read more
fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future, [src]
fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future, Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more
fn join<Fut2>(self, other: Fut2) -> Join<Self, Fut2> where
Fut2: Future, [src]
fn join<Fut2>(self, other: Fut2) -> Join<Self, Fut2> where
Fut2: Future, Joins the result of two futures, waiting for them both to complete. Read more
fn join3<Fut2, Fut3>(
self,
future2: Fut2,
future3: Fut3
) -> Join3<Self, Fut2, Fut3> where
Fut2: Future,
Fut3: Future, [src]
fn join3<Fut2, Fut3>(
self,
future2: Fut2,
future3: Fut3
) -> Join3<Self, Fut2, Fut3> where
Fut2: Future,
Fut3: Future, Same as join, but with more futures. Read more
fn join4<Fut2, Fut3, Fut4>(
self,
future2: Fut2,
future3: Fut3,
future4: Fut4
) -> Join4<Self, Fut2, Fut3, Fut4> where
Fut2: Future,
Fut3: Future + Future,
Fut4: Future, [src]
fn join4<Fut2, Fut3, Fut4>(
self,
future2: Fut2,
future3: Fut3,
future4: Fut4
) -> Join4<Self, Fut2, Fut3, Fut4> where
Fut2: Future,
Fut3: Future + Future,
Fut4: Future, Same as join, but with more futures. Read more
fn join5<Fut2, Fut3, Fut4, Fut5>(
self,
future2: Fut2,
future3: Fut3,
future4: Fut4,
future5: Fut5
) -> Join5<Self, Fut2, Fut3, Fut4, Fut5> where
Fut2: Future,
Fut3: Future + Future,
Fut4: Future,
Fut5: Future, [src]
fn join5<Fut2, Fut3, Fut4, Fut5>(
self,
future2: Fut2,
future3: Fut3,
future4: Fut4,
future5: Fut5
) -> Join5<Self, Fut2, Fut3, Fut4, Fut5> where
Fut2: Future,
Fut3: Future + Future,
Fut4: Future,
Fut5: Future, Same as join, but with more futures. Read more
fn into_stream(self) -> IntoStream<Self>[src]
fn into_stream(self) -> IntoStream<Self>Convert this future into a single element stream. Read more
fn flatten(self) -> Flatten<Self> where
Self::Output: Future, [src]
fn flatten(self) -> Flatten<Self> where
Self::Output: Future, Flatten the execution of this future when the successful result of this future is itself another future. Read more
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream, [src]
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream, Flatten the execution of this future when the successful result of this future is a stream. Read more
fn fuse(self) -> Fuse<Self>[src]
fn fuse(self) -> Fuse<Self>Fuse a future such that poll will never again be called once it has completed. Read more
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output), [src]
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output), Do something with the output of a future before passing it on. Read more
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe, [src]
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe, Catches unwinding panics while polling the future. Read more
Create a cloneable handle to this future where all handles will resolve to the same result. Read more
fn with_executor<E>(self, executor: E) -> WithExecutor<Self, E> where
E: Executor, [src]
fn with_executor<E>(self, executor: E) -> WithExecutor<Self, E> where
E: Executor, Assigns the provided Executor to be used when spawning tasks from within the future. Read more
fn poll_unpin(&mut self, cx: &mut Context) -> Poll<Self::Output> where
Self: Unpin, [src]
fn poll_unpin(&mut self, cx: &mut Context) -> Poll<Self::Output> where
Self: Unpin, A convenience for calling Future::poll on Unpin future types.