Struct futures_util::stream::Map[−][src]

pub struct Map<St, F> { /* fields omitted */ }

Expand description

Stream for the map method.

Implementations

[src]

impl<St, F> Map<St, F>

[src]

pub fn get_ref(&self) -> &St

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

[src]

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.

[src]

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.

[src]

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

[src]

impl<St, F> Debug for Map<St, F> where
St: Debug,

[src]

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

Formats the value using the given formatter. Read more

[src]

impl<St, F> FusedStream for Map<St, F> where
St: FusedStream,
F: FnMut1<St::Item>,

[src]

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

[src]

impl<St, F, Item> Sink<Item> for Map<St, F> where
St: Stream + Sink<Item>,
F: FnMut1<St::Item>,

type Error = St::Error

The type of value produced by the sink when an error occurs.

[src]

fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value. Read more

[src]

fn start_send(self: Pin<&mut Self>, item: Item) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())). Read more

[src]

fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink. Read more

[src]

fn poll_close(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary. Read more

[src]

impl<St, F> Stream for Map<St, F> where
St: Stream,
F: FnMut1<St::Item>,

type Item = F::Output

Values yielded by the stream.

[src]

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

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

[src]

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

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

[src]

impl<'pin, St, F> Unpin for Map<St, F> where
Origin<'__pin, St, F>: Unpin,

Auto Trait Implementations

impl<St, F> RefUnwindSafe for Map<St, F> where
F: RefUnwindSafe,
St: RefUnwindSafe,

impl<St, F> Send for Map<St, F> where
F: Send,
St: Send,

impl<St, F> Sync for Map<St, F> where
F: Sync,
St: Sync,

impl<St, F> UnwindSafe for Map<St, F> where
F: UnwindSafe,
St: UnwindSafe,

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,

[src]

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
 F: FnMut(U) -> Fut,
 Fut: Future<Output = Result<Item, E>>,
 E: From<Self::Error>,
 Self: Sized,

Composes a function in front of the sink. Read more

[src]

fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where
 F: FnMut(U) -> St,
 St: Stream<Item = Result<Item, Self::Error>>,
 Self: Sized,

Composes a function in front of the sink. Read more

[src]

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
Self: Sized,

Transforms the error returned by the sink.

[src]

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self: Sized,
Self::Error: Into<E>,

Map this sink’s error to a different error type using the Into trait. Read more

[src]

fn buffer(self, capacity: usize) -> Buffer<Self, Item> where
Self: Sized,

Adds a fixed-size buffer to the current sink. Read more

[src]

fn close(&mut self) -> Close<'_, Self, Item>ⓘ
Notable traits for Close<'_, Si, Item>
`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Close<'_, Si, Item> type Output = Result<(), Si::Error>;`
where
Self: Unpin,

Close the sink.

[src]

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
 Self: Sized,
 Item: Clone,
 Si: Sink<Item, Error = Self::Error>,

Fanout items to multiple sinks. Read more

[src]

fn flush(&mut self) -> Flush<'_, Self, Item>ⓘ
Notable traits for Flush<'_, Si, Item>
`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Flush<'_, Si, Item> type Output = Result<(), Si::Error>;`
where
Self: Unpin,

Flush the sink, processing all pending items. Read more

[src]

fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘ
Notable traits for Send<'_, Si, Item>
`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Send<'_, Si, Item> type Output = Result<(), Si::Error>;`
where
Self: Unpin,

A future that completes after the given item has been fully processed into the sink, including flushing. Read more

[src]

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘ
Notable traits for Feed<'_, Si, Item>
`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Feed<'_, Si, Item> type Output = Result<(), Si::Error>;`
where
Self: Unpin,

A future that completes after the given item has been received by the sink. Read more

[src]

fn send_all<'a, St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St>ⓘ
Notable traits for SendAll<'_, Si, St>
`impl<Si, St, Ok, Error> Future for SendAll<'_, Si, St> where Si: Sink<Ok, Error = Error> + Unpin + ?Sized, St: Stream<Item = Result<Ok, Error>> + Unpin + ?Sized, type Output = Result<(), Error>;`
where
 St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
 Self: Unpin,

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

[src]

fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘ
Notable traits for Either<A, B>
`impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output;`
where
 Si2: Sink<Item, Error = Self::Error>,
 Self: Sized,

Wrap this sink in an Either sink, making it the left-hand variant of that Either. Read more

[src]

fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘ
Notable traits for Either<A, B>
`impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output;`
where
 Si1: Sink<Item, Error = Self::Error>,
 Self: Sized,

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

[src]

fn poll_ready_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
 Self: Unpin,

A convenience method for calling Sink::poll_ready on Unpin sink types. Read more

[src]

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,

A convenience method for calling Sink::start_send on Unpin sink types. Read more

[src]

fn poll_flush_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
 Self: Unpin,

A convenience method for calling Sink::poll_flush on Unpin sink types. Read more

[src]

fn poll_close_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
 Self: Unpin,

A convenience method for calling Sink::poll_close on Unpin sink types. Read more

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

[src]

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::Map[−][src]

Implementations

impl<St, F> Map<St, F>

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, F> Debug for Map<St, F> where St: Debug,

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

impl<St, F> FusedStream for Map<St, F> where St: FusedStream, F: FnMut1<St::Item>,

fn is_terminated(&self) -> bool

impl<St, F, Item> Sink<Item> for Map<St, F> where St: Stream + Sink<Item>, F: FnMut1<St::Item>,

type Error = St::Error

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

fn start_send(self: Pin<&mut Self>, item: Item) -> Result<(), Self::Error>

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

impl<St, F> Stream for Map<St, F> where St: Stream, F: FnMut1<St::Item>,

type Item = F::Output

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

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

impl<'__pin, St, F> Unpin for Map<St, F> where __Origin<'__pin, St, F>: Unpin,

Auto Trait Implementations

impl<St, F> RefUnwindSafe for Map<St, F> where F: RefUnwindSafe, St: RefUnwindSafe,

impl<St, F> Send for Map<St, F> where F: Send, St: Send,

impl<St, F> Sync for Map<St, F> where F: Sync, St: Sync,

impl<St, F> UnwindSafe for Map<St, F> where F: 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, Item> SinkExt<Item> for T where T: Sink<Item> + ?Sized,

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where F: FnMut(U) -> Fut, Fut: Future<Output = Result<Item, E>>, E: From<Self::Error>, Self: Sized,

fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where F: FnMut(U) -> St, St: Stream<Item = Result<Item, Self::Error>>, Self: Sized,

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where F: FnOnce(Self::Error) -> E, Self: Sized,

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where Self: Sized, Self::Error: Into<E>,

fn buffer(self, capacity: usize) -> Buffer<Self, Item> where Self: Sized,

fn close(&mut self) -> Close<'_, Self, Item>ⓘNotable traits for Close<'_, Si, Item>impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Close<'_, Si, Item> type Output = Result<(), Si::Error>; where Self: Unpin,

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where Self: Sized, Item: Clone, Si: Sink<Item, Error = Self::Error>,

fn flush(&mut self) -> Flush<'_, Self, Item>ⓘNotable traits for Flush<'_, Si, Item>impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Flush<'_, Si, Item> type Output = Result<(), Si::Error>; where Self: Unpin,

fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘNotable traits for Send<'_, Si, Item>impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Send<'_, Si, Item> type Output = Result<(), Si::Error>; where Self: Unpin,

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘNotable traits for Feed<'_, Si, Item>impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Feed<'_, Si, Item> type Output = Result<(), Si::Error>; where Self: Unpin,

fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output; where Si2: Sink<Item, Error = Self::Error>, Self: Sized,

fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output; where Si1: Sink<Item, Error = Self::Error>, Self: Sized,

fn poll_ready_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> where Self: Unpin,

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where Self: Unpin,

fn poll_flush_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> where Self: Unpin,

fn poll_close_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> where Self: Unpin,

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>>>

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, F> Debug for Map<St, F> where
St: Debug,

impl<St, F> FusedStream for Map<St, F> where
St: FusedStream,
F: FnMut1<St::Item>,

impl<St, F, Item> Sink<Item> for Map<St, F> where
St: Stream + Sink<Item>,
F: FnMut1<St::Item>,

fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

fn poll_close(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

impl<St, F> Stream for Map<St, F> where
St: Stream,
F: FnMut1<St::Item>,

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

impl<'pin, St, F> Unpin for Map<St, F> where
Origin<'__pin, St, F>: Unpin,

impl<St, F> RefUnwindSafe for Map<St, F> where
F: RefUnwindSafe,
St: RefUnwindSafe,

impl<St, F> Send for Map<St, F> where
F: Send,
St: Send,

impl<St, F> Sync for Map<St, F> where
F: Sync,
St: Sync,

impl<St, F> UnwindSafe for Map<St, F> where
F: 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, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
E: From<Self::Error>,
Self: Sized,

fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>,
Self: Sized,

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
Self: Sized,

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self: Sized,
Self::Error: Into<E>,

fn buffer(self, capacity: usize) -> Buffer<Self, Item> where
Self: Sized,

fn close(&mut self) -> Close<'_, Self, Item>ⓘ
Notable traits for Close<'_, Si, Item>
`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Close<'_, Si, Item> type Output = Result<(), Si::Error>;`
where
Self: Unpin,

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Self: Sized,
Item: Clone,
Si: Sink<Item, Error = Self::Error>,

fn flush(&mut self) -> Flush<'_, Self, Item>ⓘ
Notable traits for Flush<'_, Si, Item>
`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Flush<'_, Si, Item> type Output = Result<(), Si::Error>;`
where
Self: Unpin,

fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘ
Notable traits for Send<'_, Si, Item>
`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Send<'_, Si, Item> type Output = Result<(), Si::Error>;`
where
Self: Unpin,

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘ
Notable traits for Feed<'_, Si, Item>
`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Feed<'_, Si, Item> type Output = Result<(), Si::Error>;`
where
Self: Unpin,

fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘ
Notable traits for Either<A, B>
`impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output;`
where
Si2: Sink<Item, Error = Self::Error>,
Self: Sized,

fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘ
Notable traits for Either<A, B>
`impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output;`
where
Si1: Sink<Item, Error = Self::Error>,
Self: Sized,

fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,

fn poll_flush_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,

fn poll_close_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,

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>>>