[−][src]Struct futures::stream::StreamFuture
A combinator used to temporarily convert a stream into a future.
This future is returned by the Stream::into_future
method.
Methods
impl<S> StreamFuture<S>
[src]
pub fn get_ref(&self) -> Option<&S>
[src]
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 S>
[src]
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<S>
[src]
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<S: Stream> Future for StreamFuture<S>
[src]
type Item = (Option<S::Item>, S)
The type of value that this future will resolved with if it is successful. Read more
type Error = (S::Error, S)
The type of error that this future will resolve with if it fails in a normal fashion. Read more
fn poll(&mut self) -> Poll<Self::Item, Self::Error>
[src]
fn wait(self) -> Result<Self::Item, Self::Error> where
Self: Sized,
[src]
Self: Sized,
fn map<F, U>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Item) -> U,
Self: Sized,
[src]
F: FnOnce(Self::Item) -> U,
Self: Sized,
fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
Self: Sized,
[src]
F: FnOnce(Self::Error) -> E,
Self: Sized,
fn from_err<E: From<Self::Error>>(self) -> FromErr<Self, E> where
Self: Sized,
[src]
Self: Sized,
fn then<F, B>(self, f: F) -> Then<Self, B, F> where
F: FnOnce(Result<Self::Item, Self::Error>) -> B,
B: IntoFuture,
Self: Sized,
[src]
F: FnOnce(Result<Self::Item, Self::Error>) -> B,
B: IntoFuture,
Self: Sized,
fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where
F: FnOnce(Self::Item) -> B,
B: IntoFuture<Error = Self::Error>,
Self: Sized,
[src]
F: FnOnce(Self::Item) -> B,
B: IntoFuture<Error = Self::Error>,
Self: Sized,
fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where
F: FnOnce(Self::Error) -> B,
B: IntoFuture<Item = Self::Item>,
Self: Sized,
[src]
F: FnOnce(Self::Error) -> B,
B: IntoFuture<Item = Self::Item>,
Self: Sized,
fn select<B>(self, other: B) -> Select<Self, B::Future> where
B: IntoFuture<Item = Self::Item, Error = Self::Error>,
Self: Sized,
[src]
B: IntoFuture<Item = Self::Item, Error = Self::Error>,
Self: Sized,
fn select2<B>(self, other: B) -> Select2<Self, B::Future> where
B: IntoFuture,
Self: Sized,
[src]
B: IntoFuture,
Self: Sized,
fn join<B>(self, other: B) -> Join<Self, B::Future> where
B: IntoFuture<Error = Self::Error>,
Self: Sized,
[src]
B: IntoFuture<Error = Self::Error>,
Self: Sized,
fn join3<B, C>(self, b: B, c: C) -> Join3<Self, B::Future, C::Future> where
B: IntoFuture<Error = Self::Error>,
C: IntoFuture<Error = Self::Error>,
Self: Sized,
[src]
B: IntoFuture<Error = Self::Error>,
C: IntoFuture<Error = Self::Error>,
Self: Sized,
fn join4<B, C, D>(
self,
b: B,
c: C,
d: D
) -> Join4<Self, B::Future, C::Future, D::Future> where
B: IntoFuture<Error = Self::Error>,
C: IntoFuture<Error = Self::Error>,
D: IntoFuture<Error = Self::Error>,
Self: Sized,
[src]
self,
b: B,
c: C,
d: D
) -> Join4<Self, B::Future, C::Future, D::Future> where
B: IntoFuture<Error = Self::Error>,
C: IntoFuture<Error = Self::Error>,
D: IntoFuture<Error = Self::Error>,
Self: Sized,
fn join5<B, C, D, E>(
self,
b: B,
c: C,
d: D,
e: E
) -> Join5<Self, B::Future, C::Future, D::Future, E::Future> where
B: IntoFuture<Error = Self::Error>,
C: IntoFuture<Error = Self::Error>,
D: IntoFuture<Error = Self::Error>,
E: IntoFuture<Error = Self::Error>,
Self: Sized,
[src]
self,
b: B,
c: C,
d: D,
e: E
) -> Join5<Self, B::Future, C::Future, D::Future, E::Future> where
B: IntoFuture<Error = Self::Error>,
C: IntoFuture<Error = Self::Error>,
D: IntoFuture<Error = Self::Error>,
E: IntoFuture<Error = Self::Error>,
Self: Sized,
fn into_stream(self) -> IntoStream<Self> where
Self: Sized,
[src]
Self: Sized,
fn flatten(self) -> Flatten<Self> where
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error: From<Self::Error>,
Self: Sized,
[src]
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error: From<Self::Error>,
Self: Sized,
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Item: Stream<Error = Self::Error>,
Self: Sized,
[src]
Self::Item: Stream<Error = Self::Error>,
Self: Sized,
fn fuse(self) -> Fuse<Self> where
Self: Sized,
[src]
Self: Sized,
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Item),
Self: Sized,
[src]
F: FnOnce(&Self::Item),
Self: Sized,
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: Sized + UnwindSafe,
[src]
Self: Sized + UnwindSafe,
fn shared(self) -> Shared<Self> where
Self: Sized,
[src]
Self: Sized,
impl<S: Debug> Debug for StreamFuture<S>
[src]
Auto Trait Implementations
impl<S> Unpin for StreamFuture<S> where
S: Unpin,
S: Unpin,
impl<S> Send for StreamFuture<S> where
S: Send,
S: Send,
impl<S> Sync for StreamFuture<S> where
S: Sync,
S: Sync,
impl<S> UnwindSafe for StreamFuture<S> where
S: UnwindSafe,
S: UnwindSafe,
impl<S> RefUnwindSafe for StreamFuture<S> where
S: RefUnwindSafe,
S: RefUnwindSafe,
Blanket Implementations
impl<F> IntoFuture for F where
F: Future,
[src]
F: Future,
type Future = F
The future that this type can be converted into.
type Item = <F as Future>::Item
The item that the future may resolve with.
type Error = <F as Future>::Error
The error that the future may resolve with.
fn into_future(Self) -> F
[src]
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,