[−][src]Struct futures_util::stream::Map
A stream combinator which will change the type of a stream from one type to another.
This is produced by the Stream::map
method.
Methods
impl<S, F> Map<S, F>
[src]
impl<S, F> Map<S, F>
pub fn get_ref(&self) -> &S
[src]
pub fn get_ref(&self) -> &S
Acquires a reference to the underlying stream that this combinator is pulling from.
pub fn get_mut(&mut self) -> &mut S
[src]
pub fn get_mut(&mut self) -> &mut S
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.
pub fn into_inner(self) -> S
[src]
pub fn into_inner(self) -> S
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.
Trait Implementations
impl<S: Debug, F: Debug> Debug for Map<S, F>
[src]
impl<S: Debug, F: Debug> Debug for Map<S, F>
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl<S, F, U> Stream for Map<S, F> where
S: Stream,
F: FnMut(S::Item) -> U,
[src]
impl<S, F, U> Stream for Map<S, F> where
S: Stream,
F: FnMut(S::Item) -> U,
type Item = U
Values yielded by the stream.
type Error = S::Error
Errors yielded by the stream.
fn poll_next(&mut self, cx: &mut Context) -> Poll<Option<U>, S::Error>
[src]
fn poll_next(&mut self, cx: &mut Context) -> Poll<Option<U>, S::Error>
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
impl<S, F> Sink for Map<S, F> where
S: Sink,
[src]
impl<S, F> Sink for Map<S, F> where
S: Sink,
type SinkItem = S::SinkItem
The type of value that the sink accepts.
type SinkError = S::SinkError
The type of value produced by the sink when an error occurs.
fn poll_ready(&mut self, cx: &mut Context) -> Poll<(), Self::SinkError>
[src]
fn poll_ready(&mut self, cx: &mut Context) -> Poll<(), Self::SinkError>
Attempts to prepare the Sink
to receive a value. Read more
fn start_send(&mut self, item: Self::SinkItem) -> Result<(), Self::SinkError>
[src]
fn start_send(&mut self, item: Self::SinkItem) -> Result<(), Self::SinkError>
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 Ok(Async::Ready(()))
. Read more
fn poll_flush(&mut self, cx: &mut Context) -> Poll<(), Self::SinkError>
[src]
fn poll_flush(&mut self, cx: &mut Context) -> Poll<(), Self::SinkError>
Flush any remaining output from this sink. Read more
fn poll_close(&mut self, cx: &mut Context) -> Poll<(), Self::SinkError>
[src]
fn poll_close(&mut self, cx: &mut Context) -> Poll<(), Self::SinkError>
Flush any remaining output and close this sink, if necessary. Read more
Auto Trait Implementations
impl<S, F> Send for Map<S, F> where
F: Send,
S: Send,
impl<S, F> Send for Map<S, F> where
F: Send,
S: Send,
impl<S, F> Sync for Map<S, F> where
F: Sync,
S: Sync,
impl<S, F> Sync for Map<S, F> where
F: Sync,
S: Sync,
Blanket Implementations
impl<T> StreamExt for T where
T: Stream + ?Sized,
[src]
impl<T> StreamExt for T where
T: Stream + ?Sized,
fn next(self) -> StreamFuture<Self> where
Self: Sized,
[src]
fn next(self) -> StreamFuture<Self> where
Self: Sized,
Converts this stream into a Future
. Read more
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> U,
Self: Sized,
[src]
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> U,
Self: Sized,
Converts a stream of type T
to a stream of type U
. Read more
fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
F: FnMut(Self::Error) -> U,
Self: Sized,
[src]
fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
F: FnMut(Self::Error) -> U,
Self: Sized,
Converts a stream of error type T
to a stream of error type U
. Read more
fn filter<R, P>(self, pred: P) -> Filter<Self, R, P> where
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Self: Sized,
[src]
fn filter<R, P>(self, pred: P) -> Filter<Self, R, P> where
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Self: Sized,
Filters the values produced by this stream according to the provided predicate. Read more
fn filter_map<R, B, F>(self, f: F) -> FilterMap<Self, R, F> where
F: FnMut(Self::Item) -> R,
R: IntoFuture<Item = Option<B>, Error = Self::Error>,
Self: Sized,
[src]
fn filter_map<R, B, F>(self, f: F) -> FilterMap<Self, R, F> where
F: FnMut(Self::Item) -> R,
R: IntoFuture<Item = Option<B>, Error = Self::Error>,
Self: Sized,
Filters the values produced by this stream while simultaneously mapping them to a different type. Read more
fn then<U, F>(self, f: F) -> Then<Self, U, F> where
F: FnMut(Result<Self::Item, Self::Error>) -> U,
U: IntoFuture,
Self: Sized,
[src]
fn then<U, F>(self, f: F) -> Then<Self, U, F> where
F: FnMut(Result<Self::Item, Self::Error>) -> U,
U: IntoFuture,
Self: Sized,
Chain on a computation for when a value is ready, passing the resulting item to the provided closure f
. Read more
fn and_then<U, F>(self, f: F) -> AndThen<Self, U, F> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Error = Self::Error>,
Self: Sized,
[src]
fn and_then<U, F>(self, f: F) -> AndThen<Self, U, F> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Error = Self::Error>,
Self: Sized,
Chain on a computation for when a value is ready, passing the successful results to the provided closure f
. Read more
fn or_else<U, F>(self, f: F) -> OrElse<Self, U, F> where
F: FnMut(Self::Error) -> U,
U: IntoFuture<Item = Self::Item>,
Self: Sized,
[src]
fn or_else<U, F>(self, f: F) -> OrElse<Self, U, F> where
F: FnMut(Self::Error) -> U,
U: IntoFuture<Item = Self::Item>,
Self: Sized,
Chain on a computation for when an error happens, passing the erroneous result to the provided closure f
. Read more
fn collect<C: Default + Extend<Self::Item>>(self) -> Collect<Self, C> where
Self: Sized,
[src]
fn collect<C: Default + Extend<Self::Item>>(self) -> Collect<Self, C> where
Self: Sized,
Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more
fn concat(self) -> Concat<Self> where
Self: Sized,
Self::Item: Extend<<Self::Item as IntoIterator>::Item> + IntoIterator + Default,
[src]
fn concat(self) -> Concat<Self> where
Self: Sized,
Self::Item: Extend<<Self::Item as IntoIterator>::Item> + IntoIterator + Default,
Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. Read more
fn fold<T, Fut, F>(self, init: T, f: F) -> Fold<Self, Fut, T, F> where
F: FnMut(T, Self::Item) -> Fut,
Fut: IntoFuture<Item = T, Error = Self::Error>,
Self: Sized,
[src]
fn fold<T, Fut, F>(self, init: T, f: F) -> Fold<Self, Fut, T, F> where
F: FnMut(T, Self::Item) -> Fut,
Fut: IntoFuture<Item = T, Error = Self::Error>,
Self: Sized,
Execute an accumulating computation over a stream, collecting all the values into one final result. Read more
fn flatten(self) -> Flatten<Self> where
Self::Item: Stream<Error = Self::Error>,
Self: Sized,
[src]
fn flatten(self) -> Flatten<Self> where
Self::Item: Stream<Error = Self::Error>,
Self: Sized,
Flattens a stream of streams into just one continuous stream. Read more
fn skip_while<R, P>(self, pred: P) -> SkipWhile<Self, R, P> where
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Self: Sized,
[src]
fn skip_while<R, P>(self, pred: P) -> SkipWhile<Self, R, P> where
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Self: Sized,
Skip elements on this stream while the predicate provided resolves to true
. Read more
fn take_while<R, P>(self, pred: P) -> TakeWhile<Self, R, P> where
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Self: Sized,
[src]
fn take_while<R, P>(self, pred: P) -> TakeWhile<Self, R, P> where
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Self: Sized,
Take elements from this stream while the predicate provided resolves to true
. Read more
fn for_each<U, F>(self, f: F) -> ForEach<Self, U, F> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>,
Self: Sized,
[src]
fn for_each<U, F>(self, f: F) -> ForEach<Self, U, F> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>,
Self: Sized,
Runs this stream to completion, executing the provided closure for each element on the stream. Read more
fn for_each_concurrent<U, F>(self, f: F) -> ForEachConcurrent<Self, U, F> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>,
Self: Sized,
[src]
fn for_each_concurrent<U, F>(self, f: F) -> ForEachConcurrent<Self, U, F> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>,
Self: Sized,
Runs this stream to completion, executing the provided closure for each element on the stream. This is similar to for_each
but may begin processing an element while previous elements are still being processed. Read more
fn err_into<E>(self) -> ErrInto<Self, E> where
Self: Sized,
Self::Error: Into<E>,
[src]
fn err_into<E>(self) -> ErrInto<Self, E> where
Self: Sized,
Self::Error: Into<E>,
Map this stream's error to a different type using the Into
trait. Read more
fn take(self, amt: u64) -> Take<Self> where
Self: Sized,
[src]
fn take(self, amt: u64) -> Take<Self> where
Self: Sized,
Creates a new stream of at most amt
items of the underlying stream. Read more
fn skip(self, amt: u64) -> Skip<Self> where
Self: Sized,
[src]
fn skip(self, amt: u64) -> Skip<Self> where
Self: Sized,
Creates a new stream which skips amt
items of the underlying stream. Read more
fn fuse(self) -> Fuse<Self> where
Self: Sized,
[src]
fn fuse(self) -> Fuse<Self> where
Self: Sized,
Fuse a stream such that poll
will never again be called once it has finished. Read more
fn by_ref(&mut self) -> &mut Self where
Self: Sized,
[src]
fn by_ref(&mut self) -> &mut Self where
Self: Sized,
Borrows a stream, rather than consuming it. Read more
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: Sized + UnwindSafe,
[src]
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: Sized + UnwindSafe,
Catches unwinding panics while polling the stream. Read more
fn buffered(self, amt: usize) -> Buffered<Self> where
Self::Item: IntoFuture<Error = Self::Error>,
Self: Sized,
[src]
fn buffered(self, amt: usize) -> Buffered<Self> where
Self::Item: IntoFuture<Error = Self::Error>,
Self: Sized,
An adaptor for creating a buffered list of pending futures. Read more
fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
Self::Item: IntoFuture<Error = Self::Error>,
Self: Sized,
[src]
fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
Self::Item: IntoFuture<Error = Self::Error>,
Self: Sized,
An adaptor for creating a buffered list of pending futures (unordered). Read more
fn zip<S>(self, other: S) -> Zip<Self, S> where
S: Stream<Error = Self::Error>,
Self: Sized,
[src]
fn zip<S>(self, other: S) -> Zip<Self, S> where
S: Stream<Error = Self::Error>,
Self: Sized,
An adapter for zipping two streams together. Read more
fn chain<S>(self, other: S) -> Chain<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
[src]
fn chain<S>(self, other: S) -> Chain<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
Adapter for chaining two stream. Read more
fn peekable(self) -> Peekable<Self> where
Self: Sized,
[src]
fn peekable(self) -> Peekable<Self> where
Self: Sized,
Creates a new stream which exposes a peek
method. Read more
fn chunks(self, capacity: usize) -> Chunks<Self> where
Self: Sized,
[src]
fn chunks(self, capacity: usize) -> Chunks<Self> where
Self: Sized,
An adaptor for chunking up items of the stream inside a vector. Read more
fn select<S>(self, other: S) -> Select<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
[src]
fn select<S>(self, other: S) -> Select<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first. Read more
fn forward<S>(self, sink: S) -> Forward<Self, S> where
S: Sink<SinkItem = Self::Item>,
Self::Error: From<S::SinkError>,
Self: Sized,
[src]
fn forward<S>(self, sink: S) -> Forward<Self, S> where
S: Sink<SinkItem = Self::Item>,
Self::Error: From<S::SinkError>,
Self: Sized,
A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
Self: Sink + Sized,
[src]
fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
Self: Sink + Sized,
Splits this Stream + Sink
object into separate Stream
and Sink
objects. Read more
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item),
Self: Sized,
[src]
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item),
Self: Sized,
Do something with each item of this stream, afterwards passing it on. Read more
fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnMut(&Self::Error),
Self: Sized,
[src]
fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnMut(&Self::Error),
Self: Sized,
Do something with the error of this stream, afterwards passing it on. Read more
fn recover<E, F>(self, f: F) -> Recover<Self, E, F> where
F: FnMut(Self::Error) -> Option<Self::Item>,
Self: Sized,
[src]
fn recover<E, F>(self, f: F) -> Recover<Self, E, F> where
F: FnMut(Self::Error) -> Option<Self::Item>,
Self: Sized,
Handle errors generated by this stream by converting them into Option<Self::Item>
, such that a None
value terminates the stream. Read more
ⓘImportant traits for Either<L, R>fn left<B>(self) -> Either<Self, B> where
B: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
[src]
fn left<B>(self) -> Either<Self, B> where
B: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
: use left_stream
instead
Wrap this stream in an Either
stream, making it the left-hand variant of that Either
. Read more
ⓘImportant traits for Either<L, R>fn right<B>(self) -> Either<B, Self> where
B: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
[src]
fn right<B>(self) -> Either<B, Self> where
B: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
: use right_stream
instead
Wrap this stream in an Either
stream, making it the right-hand variant of that Either
. Read more
ⓘImportant traits for Either<L, R>fn left_stream<B>(self) -> Either<Self, B> where
B: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
[src]
fn left_stream<B>(self) -> Either<Self, B> where
B: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
Wrap this stream in an Either
stream, making it the left-hand variant of that Either
. Read more
ⓘImportant traits for Either<L, R>fn right_stream<B>(self) -> Either<B, Self> where
B: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
[src]
fn right_stream<B>(self) -> Either<B, Self> where
B: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
Wrap this stream in an Either
stream, making it the right-hand variant of that Either
. Read more
impl<T> SinkExt for T where
T: Sink + ?Sized,
[src]
impl<T> SinkExt for T where
T: Sink + ?Sized,
fn with<U, Fut, F>(self, f: F) -> With<Self, U, Fut, F> where
F: FnMut(U) -> Fut,
Fut: IntoFuture<Item = Self::SinkItem>,
Fut::Error: From<Self::SinkError>,
Self: Sized,
[src]
fn with<U, Fut, F>(self, f: F) -> With<Self, U, Fut, F> where
F: FnMut(U) -> Fut,
Fut: IntoFuture<Item = Self::SinkItem>,
Fut::Error: From<Self::SinkError>,
Self: Sized,
Composes a function in front of the sink. Read more
fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, U, St, F> where
F: FnMut(U) -> St,
St: Stream<Item = Self::SinkItem, Error = Self::SinkError>,
Self: Sized,
[src]
fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, U, St, F> where
F: FnMut(U) -> St,
St: Stream<Item = Self::SinkItem, Error = Self::SinkError>,
Self: Sized,
Composes a function in front of the sink. Read more
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::SinkError) -> E,
Self: Sized,
[src]
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::SinkError) -> E,
Self: Sized,
Transforms the error returned by the sink.
fn sink_err_into<E>(self) -> SinkErrInto<Self, E> where
Self: Sized,
Self::SinkError: Into<E>,
[src]
fn sink_err_into<E>(self) -> SinkErrInto<Self, E> where
Self: Sized,
Self::SinkError: Into<E>,
Map this sink's error to a different error type using the Into
trait. Read more
fn buffer(self, amt: usize) -> Buffer<Self> where
Self: Sized,
[src]
fn buffer(self, amt: usize) -> Buffer<Self> where
Self: Sized,
Adds a fixed-size buffer to the current sink. Read more
fn close(self) -> Close<Self> where
Self: Sized,
[src]
fn close(self) -> Close<Self> where
Self: Sized,
Close the sink. Read more
fn fanout<S>(self, other: S) -> Fanout<Self, S> where
Self: Sized,
Self::SinkItem: Clone,
S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
[src]
fn fanout<S>(self, other: S) -> Fanout<Self, S> where
Self: Sized,
Self::SinkItem: Clone,
S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
Fanout items to multiple sinks. Read more
fn flush(self) -> Flush<Self> where
Self: Sized,
[src]
fn flush(self) -> Flush<Self> where
Self: Sized,
Flush the sync, processing all pending items. Read more
fn send(self, item: Self::SinkItem) -> Send<Self> where
Self: Sized,
[src]
fn send(self, item: Self::SinkItem) -> Send<Self> where
Self: Sized,
A future that completes after the given item has been fully processed into the sink, including flushing. Read more
fn send_all<S>(self, stream: S) -> SendAll<Self, S> where
S: Stream<Item = Self::SinkItem>,
Self::SinkError: From<S::Error>,
Self: Sized,
[src]
fn send_all<S>(self, stream: S) -> SendAll<Self, S> where
S: Stream<Item = Self::SinkItem>,
Self::SinkError: From<S::Error>,
Self: Sized,
A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
ⓘImportant traits for Either<L, R>fn left_sink<B>(self) -> Either<Self, B> where
B: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
Self: Sized,
[src]
fn left_sink<B>(self) -> Either<Self, B> where
B: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
Self: Sized,
Wrap this sink in an Either
sink, making it the left-hand variant of that Either
. Read more
ⓘImportant traits for Either<L, R>fn right_sink<B>(self) -> Either<B, Self> where
B: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
Self: Sized,
[src]
fn right_sink<B>(self) -> Either<B, Self> where
B: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
Self: Sized,
Wrap this stream in an Either
stream, making it the right-hand variant of that Either
. Read more
impl<T, U> TryFrom for T where
T: From<U>,
[src]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
try_from
)Performs the conversion.
impl<T> From for T
[src]
impl<T> From for T
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
try_from
)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
try_from
)Performs the conversion.
impl<T, U> Into for T where
U: From<T>,
[src]
impl<T, U> Into for T where
U: From<T>,
impl<T> Borrow for T where
T: ?Sized,
[src]
impl<T> Borrow for T where
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
impl<T> BorrowMut for T where
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Any for T where
T: 'static + ?Sized,
fn get_type_id(&self) -> TypeId
[src]
fn get_type_id(&self) -> TypeId
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static
Gets the TypeId
of self
. Read more