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

#[must_use = "streams do nothing unless polled"]
pub struct Enumerate<St: Stream> { /* fields omitted */ }

Stream for the enumerate method.

Methods

impl<St: Stream> Enumerate<St>[src]

pub fn get_ref(&self) -> &St[src]

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

pub fn get_mut(&mut self) -> &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.

pub fn get_pin_mut<'a>(self: Pin<&'a mut Self>) -> Pin<&'a 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.

pub fn into_inner(self) -> 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.

Trait Implementations

impl<St: Stream + Unpin> Unpin for Enumerate<St>[src]

impl<St: Debug + Stream> Debug for Enumerate<St>[src]

impl<St: Stream> Stream for Enumerate<St>[src]

type Item = (usize, St::Item)

Values yielded by the stream.

impl<St: Stream + FusedStream> FusedStream for Enumerate<St>[src]

impl<S, Item> Sink<Item> for Enumerate<S> where
    S: Stream + Sink<Item>, [src]

type Error = S::Error

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

Auto Trait Implementations

impl<St> Send for Enumerate<St> where
    St: Send, 

impl<St> Sync for Enumerate<St> where
    St: Sync, 

impl<St> UnwindSafe for Enumerate<St> where
    St: UnwindSafe, 

impl<St> RefUnwindSafe for Enumerate<St> where
    St: RefUnwindSafe, 

Blanket Implementations

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

ⓘImportant traits for Next<'_, St>
fn next(&mut self) -> Next<Self> where
    Self: Unpin, [src]

Creates a future that resolves to the next item in the stream. Read more

ⓘImportant traits for StreamFuture<St>
fn into_future(self) -> StreamFuture<Self> where
    Self: Sized + Unpin, [src]

Converts this stream into a future of (next_item, tail_of_stream). If the stream terminates, then the next item is None. Read more

fn map<T, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> T,
    Self: Sized, [src]

Maps this stream's items to a different type, returning a new stream of the resulting type. Read more

fn enumerate(self) -> Enumerate<Self> where
    Self: Sized, [src]

Creates a stream which gives the current iteration count as well as the next value. Read more

fn filter<Fut, F>(self, f: F) -> Filter<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>,
    Self: Sized, [src]

Filters the values produced by this stream according to the provided asynchronous predicate. Read more

fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = Option<T>>,
    Self: Sized, [src]

Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided asynchronous closure. Read more

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future,
    Self: Sized, [src]

Computes from this stream's items new items of a different type using an asynchronous closure. Read more

ⓘImportant traits for Collect<St, C>
fn collect<C: Default + Extend<Self::Item>>(self) -> Collect<Self, C> where
    Self: Sized, [src]

Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more

ⓘImportant traits for Concat<St>
fn concat(self) -> Concat<Self> where
    Self: Sized,
    Self::Item: Extend<<Self::Item as IntoIterator>::Item> + IntoIterator + Default, [src]

Concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more

ⓘImportant traits for Fold<St, Fut, T, F>
fn fold<T, Fut, F>(self, init: T, f: F) -> Fold<Self, Fut, T, F> where
    F: FnMut(T, Self::Item) -> Fut,
    Fut: Future<Output = T>,
    Self: Sized, [src]

Execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Item: Stream,
    Self: Sized, [src]

Flattens a stream of streams into just one continuous stream. Read more

fn skip_while<Fut, F>(self, f: F) -> SkipWhile<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>,
    Self: Sized, [src]

Skip elements on this stream while the provided asynchronous predicate resolves to true. Read more

fn take_while<Fut, F>(self, f: F) -> TakeWhile<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>,
    Self: Sized, [src]

Take elements from this stream while the provided asynchronous predicate resolves to true. Read more

ⓘImportant traits for ForEach<St, Fut, F>
fn for_each<Fut, F>(self, f: F) -> ForEach<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = ()>,
    Self: Sized, [src]

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more

ⓘImportant traits for ForEachConcurrent<St, Fut, F>
fn for_each_concurrent<Fut, F>(
    self,
    limit: impl Into<Option<usize>>,
    f: F
) -> ForEachConcurrent<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = ()>,
    Self: Sized, [src]

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available. Read more

fn take(self, n: u64) -> Take<Self> where
    Self: Sized, [src]

Creates a new stream of at most n items of the underlying stream. Read more

fn skip(self, n: u64) -> Skip<Self> where
    Self: Sized, [src]

Creates a new stream which skips n items of the underlying stream. Read more

fn fuse(self) -> Fuse<Self> where
    Self: Sized, [src]

Fuse a stream such that poll_next will never again be called once it has finished. This method can be used t turn any Stream into a FusedStream. Read more

fn by_ref(&mut self) -> &mut Self[src]

Borrows a stream, rather than consuming it. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: Sized + UnwindSafe, [src]

Catches unwinding panics while polling the stream. Read more

fn boxed(self) -> Pin<Box<Self>> where
    Self: Sized, [src]

Wrap the stream in a Box, pinning it. Read more

fn buffered(self, n: usize) -> Buffered<Self> where
    Self::Item: Future,
    Self: Sized, [src]

An adaptor for creating a buffered list of pending futures. Read more

fn buffer_unordered(self, n: usize) -> BufferUnordered<Self> where
    Self::Item: Future,
    Self: Sized, [src]

An adaptor for creating a buffered list of pending futures (unordered). Read more

fn zip<St>(self, other: St) -> Zip<Self, St> where
    St: Stream,
    Self: Sized, [src]

An adapter for zipping two streams together. Read more

fn chain<St>(self, other: St) -> Chain<Self, St> where
    St: Stream<Item = Self::Item>,
    Self: Sized, [src]

Adapter for chaining two stream. Read more

fn peekable(self) -> Peekable<Self> where
    Self: Sized, [src]

Creates a new stream which exposes a peek method. Read more

fn chunks(self, capacity: usize) -> Chunks<Self> where
    Self: Sized, [src]

An adaptor for chunking up items of the stream inside a vector. Read more

ⓘImportant traits for Forward<St, Si>
fn forward<S>(self, sink: S) -> Forward<Self, S> where
    S: Sink<Self::Ok>,
    Self: TryStream<Error = S::Error> + Sized, [src]

A future that completes after the given stream has been fully processed into the sink and the sink has been flushed and closed. Read more

fn split<Item>(self) -> (SplitSink<Self, Item>, SplitStream<Self>) where
    Self: Sink<Item> + Sized, [src]

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]

Do something with each item of this stream, afterwards passing it on. Read more

ⓘImportant traits for Either<A, B>
fn left_stream<B>(self) -> Either<Self, B> where
    B: Stream<Item = Self::Item>,
    Self: Sized, [src]

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

ⓘImportant traits for Either<A, B>
fn right_stream<B>(self) -> Either<B, Self> where
    B: Stream<Item = Self::Item>,
    Self: Sized, [src]

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

fn poll_next_unpin(&mut self, cx: &mut Context) -> Poll<Option<Self::Item>> where
    Self: Unpin, [src]

A convenience method for calling Stream::poll_next on Unpin stream types. Read more

ⓘImportant traits for SelectNextSome<'_, St>
fn select_next_some(&mut self) -> SelectNextSome<Self> where
    Self: Unpin + FusedStream, [src]

Returns a Future that resolves when the next item in this stream is ready. Read more

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, [src]

Composes a function in front of the sink. Read more

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, [src]

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::Error) -> E,
    Self: Sized, [src]

Transforms the error returned by the sink.

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

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

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

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

ⓘImportant traits for Close<'_, Si, Item>
fn close(&mut self) -> Close<Self, Item> where
    Self: Unpin, [src]

Close the sink.

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

Fanout items to multiple sinks. Read more

ⓘImportant traits for Flush<'_, Si, Item>
fn flush(&mut self) -> Flush<Self, Item> where
    Self: Unpin, [src]

Flush the sync, processing all pending items. Read more

ⓘImportant traits for Send<'_, Si, Item>
fn send(&mut self, item: Item) -> Send<Self, Item> where
    Self: Unpin, [src]

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

ⓘImportant traits for SendAll<'_, Si, St>
fn send_all<'a, St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
    St: Stream<Item = Item> + Unpin,
    Self: Unpin, [src]

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

ⓘImportant traits for Either<A, B>
fn left_sink<Si2>(self) -> Either<Self, Si2> where
    Si2: Sink<Item, Error = Self::Error>,
    Self: Sized, [src]

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

ⓘImportant traits for Either<A, B>
fn right_sink<Si1>(self) -> Either<Si1, Self> where
    Si1: Sink<Item, Error = Self::Error>,
    Self: Sized, [src]

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

fn compat(self) -> CompatSink<Self, Item> where
    Self: Sized + Unpin, [src]

Wraps a Sink into a sink compatible with libraries using futures 0.1 Sink. Requires the compat feature to be enabled. Read more

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

The type returned in the event of a conversion error.

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

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

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

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,