[−][src]Struct futures::stream::Peek

[+] Show declaration

[+] Expand attributes
#[must_use = "futures do nothing unless polled"]pub struct Peek<'a, St> where
    St: Stream,  { /* fields omitted */ }

[−]

Future for the Peekable::peek() function from Peekable

Trait Implementations

`impl<'_, St> Debug for Peek<'_, St> where St: Stream + Debug, <St as Stream>::Item: Debug,` [src][+]

[+] Show hidden undocumented items

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src][−]

`impl<'_, St> FusedFuture for Peek<'_, St> where St: Stream,` [src][+]

[+] Show hidden undocumented items

`pub fn is_terminated(&self) -> bool`[src][−]

`impl<'a, St> Future for Peek<'a, St> where St: Stream,` [src][+]

[+] Show hidden undocumented items

`type Output = Option<&'a <St as Stream>::Item>`

The type of value produced on completion.

`pub fn poll( self: Pin<&mut Peek<'a, St>>, cx: &mut Context<'_> ) -> Poll<<Peek<'a, St> as Future>::Output>`[src][−]

`impl<'pin, 'a, St> Unpin for Peek<'a, St> where St: Stream, __Peek<'pin, 'a, St>: Unpin,` [src]

Auto Trait Implementations

`impl<'a, St> Send for Peek<'a, St> where St: Send, <St as Stream>::Item: Send,`

`impl<'a, St> Sync for Peek<'a, St> where St: Sync, <St as Stream>::Item: Sync,`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src][+]

[+] Show hidden undocumented items

`pub fn type_id(&self) -> TypeId`[src][−]

`impl<T> Borrow<T> for T where T: ?Sized,` [src][+]

[+] Show hidden undocumented items

`pub fn borrow(&self) -> &T`[src][−]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src][+]

[+] Show hidden undocumented items

`pub fn borrow_mut(&mut self) -> &mut T`[src][−]

`impl<T> From<T> for T`[src][+]

[+] Show hidden undocumented items

`pub fn from(t: T) -> T`[src][−]

`impl<T> FutureExt for T where T: Future + ?Sized,` [src][+]

[+] Show hidden undocumented items

`pub fn map<U, F>(self, f: F) -> Map<Self, F>ⓘNotable traits for Map<Fut, F> impl<Fut, F> Future for Map<Fut, F> where Map<Fut, F>: Future, type Output = <Map<Fut, F> as Future>::Output; where F: FnOnce(Self::Output) -> U,` [src][−]

`pub fn map_into(self) -> MapInto<Self, U> where Self::Output: Into,` [src][−]

`pub fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>ⓘNotable traits for Then<Fut1, Fut2, F> impl<Fut1, Fut2, F> Future for Then<Fut1, Fut2, F> where Flatten<Map<Fut1, F>, Fut2>: Future, type Output = <Flatten<Map<Fut1, F>, Fut2> as Future>::Output; where F: FnOnce(Self::Output) -> Fut, Fut: Future,` [src][−]

`pub fn left_future(self) -> Either<Self, B>ⓘNotable traits for Either<A, B> impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output; where B: Future<Output = Self::Output>,` [src][−]

`pub fn right_future<A>(self) -> Either<A, Self>ⓘNotable traits for Either<A, B> impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output; where A: Future<Output = Self::Output>,` [src][−]

`pub fn into_stream(self) -> IntoStream<Self>`[src][−]

`pub fn flatten(self) -> Flatten<Self>ⓘNotable traits for Flatten<F> impl<F> Future for Flatten<F> where F: Future, Flatten<F, <F as Future>::Output>: Future, type Output = <Flatten<F, <F as Future>::Output> as Future>::Output; where Self::Output: Future,` [src][−]

`pub fn flatten_stream(self) -> FlattenStream<Self> where Self::Output: Stream,` [src][−]

`pub fn fuse(self) -> Fuse<Self>ⓘNotable traits for Fuse<Fut> impl<Fut> Future for Fuse<Fut> where Fut: Future, type Output = <Fut as Future>::Output;`[src][−]

`pub fn inspect<F>(self, f: F) -> Inspect<Self, F>ⓘNotable traits for Inspect<Fut, F> impl<Fut, F> Future for Inspect<Fut, F> where Map<Fut, InspectFn<F>>: Future, type Output = <Map<Fut, InspectFn<F>> as Future>::Output; where F: FnOnce(&Self::Output),` [src][−]

`pub fn boxed<'a>( self ) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>>ⓘNotable traits for Pin impl Future for Pin where P: Unpin + DerefMut, ::Target: Future, type Output = <::Target as Future>::Output; where Self: Send + 'a,` [src][−]

`pub fn boxed_local<'a>( self ) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>>ⓘNotable traits for Pin impl Future for Pin where P: Unpin + DerefMut, ::Target: Future, type Output = <::Target as Future>::Output; where Self: 'a,` [src][−]

`pub fn unit_error(self) -> UnitError<Self>ⓘNotable traits for UnitError<Fut> impl<Fut> Future for UnitError<Fut> where Map<Fut, OkFn<()>>: Future, type Output = <Map<Fut, OkFn<()>> as Future>::Output;`[src][−]

`pub fn never_error(self) -> NeverError<Self>ⓘNotable traits for NeverError<Fut> impl<Fut> Future for NeverError<Fut> where Map<Fut, OkFn<Infallible>>: Future, type Output = <Map<Fut, OkFn<Infallible>> as Future>::Output;`[src][−]

`pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where Self: Unpin,` [src][−]

`pub fn now_or_never(self) -> Option<Self::Output>`[src][−]

`impl<T, U> Into for T where U: From<T>,` [src][+]

[+] Show hidden undocumented items

`pub fn into(self) -> U`[src][−]

`impl<F> IntoFuture for F where F: Future,` [src][+]

[+] Show hidden undocumented items

`type Output = <F as Future>::Output`

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

`type Future = F`

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

`pub fn into_future(self) -> <F as IntoFuture>::Future`[src][−]

`impl<T, U> TryFrom for T where U: Into<T>,` [src][+]

[+] Show hidden undocumented items

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src][−]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src][+]

[+] Show hidden undocumented items

`type Error = >::Error`

The type returned in the event of a conversion error.

[−][src]Struct futures::stream::Peek

Trait Implementations

impl<'_, St> Debug for Peek<'_, St> where St: Stream + Debug, <St as Stream>::Item: Debug, [src][+]

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src][−]

impl<'_, St> FusedFuture for Peek<'_, St> where St: Stream, [src][+]

pub fn is_terminated(&self) -> bool[src][−]

impl<'a, St> Future for Peek<'a, St> where St: Stream, [src][+]

type Output = Option<&'a <St as Stream>::Item>

pub fn poll( self: Pin<&mut Peek<'a, St>>, cx: &mut Context<'_>) -> Poll<<Peek<'a, St> as Future>::Output>[src][−]

impl<'pin, 'a, St> Unpin for Peek<'a, St> where St: Stream, __Peek<'pin, 'a, St>: Unpin, [src]

Auto Trait Implementations

impl<'a, St> Send for Peek<'a, St> where St: Send, <St as Stream>::Item: Send,

impl<'a, St> Sync for Peek<'a, St> where St: Sync, <St as Stream>::Item: Sync,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized, [src][+]

pub fn type_id(&self) -> TypeId[src][−]

impl<T> Borrow<T> for T where T: ?Sized, [src][+]

pub fn borrow(&self) -> &T[src][−]

impl<T> BorrowMut<T> for T where T: ?Sized, [src][+]

pub fn borrow_mut(&mut self) -> &mut T[src][−]

impl<T> From<T> for T[src][+]

pub fn from(t: T) -> T[src][−]

impl<T> FutureExt for T where T: Future + ?Sized, [src][+]

pub fn map<U, F>(self, f: F) -> Map<Self, F>ⓘNotable traits for Map<Fut, F>impl<Fut, F> Future for Map<Fut, F> where Map<Fut, F>: Future, type Output = <Map<Fut, F> as Future>::Output; where F: FnOnce(Self::Output) -> U, [src][−]

Notable traits for Map<Fut, F>

pub fn map_into<U>(self) -> MapInto<Self, U> where Self::Output: Into<U>, [src][−]

Notable traits for Then<Fut1, Fut2, F>

pub fn left_future<B>(self) -> Either<Self, B>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output; where B: Future<Output = Self::Output>, [src][−]

Notable traits for Either<A, B>

pub fn right_future<A>(self) -> Either<A, Self>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output; where A: Future<Output = Self::Output>, [src][−]

Notable traits for Either<A, B>

pub fn into_stream(self) -> IntoStream<Self>[src][−]

pub fn flatten(self) -> Flatten<Self>ⓘNotable traits for Flatten<F>impl<F> Future for Flatten<F> where F: Future, Flatten<F, <F as Future>::Output>: Future, type Output = <Flatten<F, <F as Future>::Output> as Future>::Output; where Self::Output: Future, [src][−]

Notable traits for Flatten<F>

pub fn flatten_stream(self) -> FlattenStream<Self> where Self::Output: Stream, [src][−]

pub fn fuse(self) -> Fuse<Self>ⓘNotable traits for Fuse<Fut>impl<Fut> Future for Fuse<Fut> where Fut: Future, type Output = <Fut as Future>::Output;[src][−]

Notable traits for Fuse<Fut>

pub fn inspect<F>(self, f: F) -> Inspect<Self, F>ⓘNotable traits for Inspect<Fut, F>impl<Fut, F> Future for Inspect<Fut, F> where Map<Fut, InspectFn<F>>: Future, type Output = <Map<Fut, InspectFn<F>> as Future>::Output; where F: FnOnce(&Self::Output), [src][−]

Notable traits for Inspect<Fut, F>

pub fn boxed<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P> where P: Unpin + DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output; where Self: Send + 'a, [src][−]

Notable traits for Pin<P>

pub fn boxed_local<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P> where P: Unpin + DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output; where Self: 'a, [src][−]

Notable traits for Pin<P>

pub fn unit_error(self) -> UnitError<Self>ⓘNotable traits for UnitError<Fut>impl<Fut> Future for UnitError<Fut> where Map<Fut, OkFn<()>>: Future, type Output = <Map<Fut, OkFn<()>> as Future>::Output;[src][−]

Notable traits for UnitError<Fut>

pub fn never_error(self) -> NeverError<Self>ⓘNotable traits for NeverError<Fut>impl<Fut> Future for NeverError<Fut> where Map<Fut, OkFn<Infallible>>: Future, type Output = <Map<Fut, OkFn<Infallible>> as Future>::Output;[src][−]

Notable traits for NeverError<Fut>

pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where Self: Unpin, [src][−]

pub fn now_or_never(self) -> Option<Self::Output>[src][−]

impl<T, U> Into<U> for T where U: From<T>, [src][+]

pub fn into(self) -> U[src][−]

impl<F> IntoFuture for F where F: Future, [src][+]

type Output = <F as Future>::Output

type Future = F

pub fn into_future(self) -> <F as IntoFuture>::Future[src][−]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src][+]

type Error = Infallible

pub 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][+]

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src][−]

`impl<'_, St> Debug for Peek<'_, St> where St: Stream + Debug, <St as Stream>::Item: Debug,` [src][+]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src][−]

`impl<'_, St> FusedFuture for Peek<'_, St> where St: Stream,` [src][+]

`pub fn is_terminated(&self) -> bool`[src][−]

`impl<'a, St> Future for Peek<'a, St> where St: Stream,` [src][+]

`type Output = Option<&'a <St as Stream>::Item>`

`pub fn poll( self: Pin<&mut Peek<'a, St>>, cx: &mut Context<'_> ) -> Poll<<Peek<'a, St> as Future>::Output>`[src][−]

`impl<'pin, 'a, St> Unpin for Peek<'a, St> where St: Stream, __Peek<'pin, 'a, St>: Unpin,` [src]

`impl<'a, St> Send for Peek<'a, St> where St: Send, <St as Stream>::Item: Send,`

`impl<'a, St> Sync for Peek<'a, St> where St: Sync, <St as Stream>::Item: Sync,`

`impl<T> Any for T where T: 'static + ?Sized,` [src][+]

`pub fn type_id(&self) -> TypeId`[src][−]

`impl<T> Borrow<T> for T where T: ?Sized,` [src][+]

`pub fn borrow(&self) -> &T`[src][−]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src][+]

`pub fn borrow_mut(&mut self) -> &mut T`[src][−]

`impl<T> From<T> for T`[src][+]

`pub fn from(t: T) -> T`[src][−]

`impl<T> FutureExt for T where T: Future + ?Sized,` [src][+]

`pub fn map<U, F>(self, f: F) -> Map<Self, F>ⓘNotable traits for Map<Fut, F> impl<Fut, F> Future for Map<Fut, F> where Map<Fut, F>: Future, type Output = <Map<Fut, F> as Future>::Output; where F: FnOnce(Self::Output) -> U,` [src][−]

`pub fn map_into<U>(self) -> MapInto<Self, U> where Self::Output: Into<U>,` [src][−]

`pub fn left_future<B>(self) -> Either<Self, B>ⓘNotable traits for Either<A, B> impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output; where B: Future<Output = Self::Output>,` [src][−]

`pub fn right_future<A>(self) -> Either<A, Self>ⓘNotable traits for Either<A, B> impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output; where A: Future<Output = Self::Output>,` [src][−]

`pub fn into_stream(self) -> IntoStream<Self>`[src][−]

`pub fn flatten(self) -> Flatten<Self>ⓘNotable traits for Flatten<F> impl<F> Future for Flatten<F> where F: Future, Flatten<F, <F as Future>::Output>: Future, type Output = <Flatten<F, <F as Future>::Output> as Future>::Output; where Self::Output: Future,` [src][−]

`pub fn flatten_stream(self) -> FlattenStream<Self> where Self::Output: Stream,` [src][−]

`pub fn fuse(self) -> Fuse<Self>ⓘNotable traits for Fuse<Fut> impl<Fut> Future for Fuse<Fut> where Fut: Future, type Output = <Fut as Future>::Output;`[src][−]

`pub fn inspect<F>(self, f: F) -> Inspect<Self, F>ⓘNotable traits for Inspect<Fut, F> impl<Fut, F> Future for Inspect<Fut, F> where Map<Fut, InspectFn<F>>: Future, type Output = <Map<Fut, InspectFn<F>> as Future>::Output; where F: FnOnce(&Self::Output),` [src][−]

`pub fn boxed<'a>( self ) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>>ⓘNotable traits for Pin<P> impl<P> Future for Pin<P> where P: Unpin + DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output; where Self: Send + 'a,` [src][−]

`pub fn boxed_local<'a>( self ) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>>ⓘNotable traits for Pin<P> impl<P> Future for Pin<P> where P: Unpin + DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output; where Self: 'a,` [src][−]

`pub fn unit_error(self) -> UnitError<Self>ⓘNotable traits for UnitError<Fut> impl<Fut> Future for UnitError<Fut> where Map<Fut, OkFn<()>>: Future, type Output = <Map<Fut, OkFn<()>> as Future>::Output;`[src][−]

`pub fn never_error(self) -> NeverError<Self>ⓘNotable traits for NeverError<Fut> impl<Fut> Future for NeverError<Fut> where Map<Fut, OkFn<Infallible>>: Future, type Output = <Map<Fut, OkFn<Infallible>> as Future>::Output;`[src][−]

`pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where Self: Unpin,` [src][−]

`pub fn now_or_never(self) -> Option<Self::Output>`[src][−]

`impl<T, U> Into<U> for T where U: From<T>,` [src][+]

`pub fn into(self) -> U`[src][−]

`impl<F> IntoFuture for F where F: Future,` [src][+]

`type Output = <F as Future>::Output`

`type Future = F`

`pub fn into_future(self) -> <F as IntoFuture>::Future`[src][−]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src][+]

`type Error = Infallible`

`pub 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][+]

`type Error = <U as TryFrom<T>>::Error`

`pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src][−]