Struct futures_util::stream::Scan

source · [−]

pub struct Scan<St: Stream, S, Fut, F> { /* private fields */ }

Expand description

Stream for the scan method.

Implementations

source

impl<B, St, S, Fut, F> Scan<St, S, Fut, F> where
 St: Stream,
 F: FnMut(&mut S, St::Item) -> Fut,
 Fut: Future<Output = Option>,

source

pub fn get_ref(&self) -> &St

Acquires a reference to the underlying sink or stream that this combinator is pulling from.

source

pub fn get_mut(&mut self) -> &mut St

Acquires a mutable reference to the underlying sink or stream that this combinator is pulling from.

Note that care must be taken to avoid tampering with the state of the sink or stream which may otherwise confuse this combinator.

source

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut St>ⓘNotable traits for Pin`impl Future for Pin where P: DerefMut, ::Target: Future, type Output = <::Target as Future>::Output;`

Acquires a pinned mutable reference to the underlying sink or stream that this combinator is pulling from.

Note that care must be taken to avoid tampering with the state of the sink or stream which may otherwise confuse this combinator.

source

pub fn into_inner(self) -> St

Consumes this combinator, returning the underlying sink or stream.

Note that this may discard intermediate state of this combinator, so care should be taken to avoid losing resources when this is called.

Trait Implementations

source

impl<St, S, Fut, F> Debug for Scan<St, S, Fut, F> where
 St: Stream + Debug,
 St::Item: Debug,
 S: Debug,
 Fut: Debug,

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source

impl<B, St, S, Fut, F> FusedStream for Scan<St, S, Fut, F> where
 St: FusedStream,
 F: FnMut(&mut S, St::Item) -> Fut,
 Fut: Future<Output = Option>,

source

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

source

impl<B, St, S, Fut, F> Stream for Scan<St, S, Fut, F> where
 St: Stream,
 F: FnMut(&mut S, St::Item) -> Fut,
 Fut: Future<Output = Option>,

type Item = B

Values yielded by the stream.

source

fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted. Read more

source

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream. Read more

source

impl<'pin, St: Stream, S, Fut, F> Unpin for Scan<St, S, Fut, F> where
Origin<'__pin, St, S, Fut, F>: Unpin,

Auto Trait Implementations

impl<St, S, Fut, F> RefUnwindSafe for Scan<St, S, Fut, F> where
 F: RefUnwindSafe,
 Fut: RefUnwindSafe,
 S: RefUnwindSafe,
 St: RefUnwindSafe,

impl<St, S, Fut, F> Send for Scan<St, S, Fut, F> where
 F: Send,
 Fut: Send,
 S: Send,
 St: Send,

impl<St, S, Fut, F> Sync for Scan<St, S, Fut, F> where
 F: Sync,
 Fut: Sync,
 S: Sync,
 St: Sync,

impl<St, S, Fut, F> UnwindSafe for Scan<St, S, Fut, F> where
 F: UnwindSafe,
 Fut: UnwindSafe,
 S: UnwindSafe,
 St: UnwindSafe,

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<S, T, E> TryStream for S where
S: Stream<Item = Result<T, E>> + ?Sized,

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

source

pub fn try_poll_next(
self: Pin<&mut S>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this TryStream as if it were a Stream. Read more

Struct futures_util::stream::Scan

Implementations

impl<B, St, S, Fut, F> Scan<St, S, Fut, F> where St: Stream, F: FnMut(&mut S, St::Item) -> Fut, Fut: Future<Output = Option<B>>,

pub fn get_ref(&self) -> &St

pub fn get_mut(&mut self) -> &mut St

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut St>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P> where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;

pub fn into_inner(self) -> St

Trait Implementations

impl<St, S, Fut, F> Debug for Scan<St, S, Fut, F> where St: Stream + Debug, St::Item: Debug, S: Debug, Fut: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl<B, St, S, Fut, F> FusedStream for Scan<St, S, Fut, F> where St: FusedStream, F: FnMut(&mut S, St::Item) -> Fut, Fut: Future<Output = Option<B>>,

fn is_terminated(&self) -> bool

impl<B, St, S, Fut, F> Stream for Scan<St, S, Fut, F> where St: Stream, F: FnMut(&mut S, St::Item) -> Fut, Fut: Future<Output = Option<B>>,

type Item = B

fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<B>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<'__pin, St: Stream, S, Fut, F> Unpin for Scan<St, S, Fut, F> where __Origin<'__pin, St, S, Fut, F>: Unpin,

Auto Trait Implementations

impl<St, S, Fut, F> RefUnwindSafe for Scan<St, S, Fut, F> where F: RefUnwindSafe, Fut: RefUnwindSafe, S: RefUnwindSafe, St: RefUnwindSafe,

impl<St, S, Fut, F> Send for Scan<St, S, Fut, F> where F: Send, Fut: Send, S: Send, St: Send,

impl<St, S, Fut, F> Sync for Scan<St, S, Fut, F> where F: Sync, Fut: Sync, S: Sync, St: Sync,

impl<St, S, Fut, F> UnwindSafe for Scan<St, S, Fut, F> where F: UnwindSafe, Fut: UnwindSafe, S: UnwindSafe, St: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

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

impl<S, T, E> TryStream for S where S: Stream<Item = Result<T, E>> + ?Sized,

type Ok = T

type Error = E

pub fn try_poll_next( self: Pin<&mut S>, cx: &mut Context<'_>) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

impl<B, St, S, Fut, F> Scan<St, S, Fut, F> where
St: Stream,
F: FnMut(&mut S, St::Item) -> Fut,
Fut: Future<Output = Option<B>>,

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut St>ⓘNotable traits for Pin<P>`impl<P> Future for Pin<P> where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;`

impl<St, S, Fut, F> Debug for Scan<St, S, Fut, F> where
St: Stream + Debug,
St::Item: Debug,
S: Debug,
Fut: Debug,

impl<B, St, S, Fut, F> FusedStream for Scan<St, S, Fut, F> where
St: FusedStream,
F: FnMut(&mut S, St::Item) -> Fut,
Fut: Future<Output = Option<B>>,

impl<B, St, S, Fut, F> Stream for Scan<St, S, Fut, F> where
St: Stream,
F: FnMut(&mut S, St::Item) -> Fut,
Fut: Future<Output = Option<B>>,

impl<'pin, St: Stream, S, Fut, F> Unpin for Scan<St, S, Fut, F> where
Origin<'__pin, St, S, Fut, F>: Unpin,

impl<St, S, Fut, F> RefUnwindSafe for Scan<St, S, Fut, F> where
F: RefUnwindSafe,
Fut: RefUnwindSafe,
S: RefUnwindSafe,
St: RefUnwindSafe,

impl<St, S, Fut, F> Send for Scan<St, S, Fut, F> where
F: Send,
Fut: Send,
S: Send,
St: Send,

impl<St, S, Fut, F> Sync for Scan<St, S, Fut, F> where
F: Sync,
Fut: Sync,
S: Sync,
St: Sync,

impl<St, S, Fut, F> UnwindSafe for Scan<St, S, Fut, F> where
F: UnwindSafe,
Fut: UnwindSafe,
S: UnwindSafe,
St: UnwindSafe,

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

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<S, T, E> TryStream for S where
S: Stream<Item = Result<T, E>> + ?Sized,

pub fn try_poll_next(
self: Pin<&mut S>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>