[−][src]Struct futures::stream::StreamFuture
Future for the into_future
method.
Methods
impl<St> StreamFuture<St> where
St: Unpin + Stream,
[src]
St: Unpin + Stream,
pub fn get_ref(&self) -> Option<&St>
[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 St>
[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 get_pin_mut(self: Pin<&mut StreamFuture<St>>) -> Option<Pin<&mut St>>
[src]
Acquires a pinned 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]
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> Future for StreamFuture<St> where
St: Unpin + Stream,
[src]
St: Unpin + Stream,
type Output = (Option<<St as Stream>::Item>, St)
The type of value produced on completion.
fn poll(
self: Pin<&mut StreamFuture<St>>,
cx: &mut Context
) -> Poll<<StreamFuture<St> as Future>::Output>
[src]
self: Pin<&mut StreamFuture<St>>,
cx: &mut Context
) -> Poll<<StreamFuture<St> as Future>::Output>
impl<St> Unpin for StreamFuture<St> where
St: Unpin + Stream,
[src]
St: Unpin + Stream,
impl<St> Debug for StreamFuture<St> where
St: Debug,
[src]
St: Debug,
impl<St> FusedFuture for StreamFuture<St> where
St: Unpin + Stream,
[src]
St: Unpin + Stream,
fn is_terminated(&self) -> bool
[src]
Auto Trait Implementations
impl<St> Send for StreamFuture<St> where
St: Send,
St: Send,
impl<St> Sync for StreamFuture<St> where
St: Sync,
St: Sync,
impl<St> UnwindSafe for StreamFuture<St> where
St: UnwindSafe,
St: UnwindSafe,
impl<St> RefUnwindSafe for StreamFuture<St> where
St: RefUnwindSafe,
St: RefUnwindSafe,
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
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> 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> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
ⓘImportant traits for &'_ mut Ffn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> FutureExt for T where
T: Future + ?Sized,
[src]
T: Future + ?Sized,
ⓘImportant traits for Map<Fut, F>fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,
[src]
F: FnOnce(Self::Output) -> U,
ⓘImportant traits for Then<Fut1, Fut2, F>fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
[src]
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
ⓘImportant traits for Either<A, B>fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,
[src]
B: Future<Output = Self::Output>,
ⓘImportant traits for Either<A, B>fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,
[src]
A: Future<Output = Self::Output>,
fn into_stream(self) -> IntoStream<Self>
[src]
ⓘImportant traits for Flatten<Fut>fn flatten(self) -> Flatten<Self> where
Self::Output: Future,
[src]
Self::Output: Future,
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
[src]
Self::Output: Stream,
ⓘImportant traits for Fuse<Fut>fn fuse(self) -> Fuse<Self>
[src]
ⓘImportant traits for Inspect<Fut, F>fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),
[src]
F: FnOnce(&Self::Output),
ⓘImportant traits for CatchUnwind<Fut>fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
[src]
Self: UnwindSafe,
ⓘImportant traits for Shared<Fut>fn shared(self) -> Shared<Self> where
Self::Output: Clone,
[src]
Self::Output: Clone,
fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)
[src]
ⓘImportant traits for Pin<P>fn boxed<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send>> where
Self: Send + 'a,
[src]
Self: Send + 'a,
ⓘImportant traits for Pin<P>fn boxed_local<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a>> where
Self: 'a,
[src]
Self: 'a,
ⓘImportant traits for UnitError<Fut>fn unit_error(self) -> UnitError<Self>
[src]
ⓘImportant traits for NeverError<Fut>fn never_error(self) -> NeverError<Self>
[src]
fn poll_unpin(&mut self, cx: &mut Context) -> Poll<Self::Output> where
Self: Unpin,
[src]
Self: Unpin,