[−][src]Struct futures::stream::TakeWhile
A stream combinator which takes elements from a stream while a predicate holds.
This structure is produced by the Stream::take_while method.
Methods
impl<S, R, P> TakeWhile<S, R, P> where
R: IntoFuture,
S: Stream, [src]
impl<S, R, P> TakeWhile<S, R, P> where
R: IntoFuture,
S: Stream, pub fn get_ref(&self) -> &S[src]
pub fn get_ref(&self) -> &SAcquires 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 SAcquires 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) -> SConsumes 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, R, P> Sink for TakeWhile<S, R, P> where
R: IntoFuture,
S: Sink + Stream, [src]
impl<S, R, P> Sink for TakeWhile<S, R, P> where
R: IntoFuture,
S: Sink + Stream, type SinkItem = <S as Sink>::SinkItem
The type of value that the sink accepts.
type SinkError = <S as Sink>::SinkError
The type of value produced by the sink when an error occurs.
fn poll_ready(
&mut self,
cx: &mut Context
) -> Result<Async<()>, <TakeWhile<S, R, P> as Sink>::SinkError>[src]
fn poll_ready(
&mut self,
cx: &mut Context
) -> Result<Async<()>, <TakeWhile<S, R, P> as Sink>::SinkError>Attempts to prepare the Sink to receive a value. Read more
fn start_send(
&mut self,
item: <TakeWhile<S, R, P> as Sink>::SinkItem
) -> Result<(), <TakeWhile<S, R, P> as Sink>::SinkError>[src]
fn start_send(
&mut self,
item: <TakeWhile<S, R, P> as Sink>::SinkItem
) -> Result<(), <TakeWhile<S, R, P> as Sink>::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
) -> Result<Async<()>, <TakeWhile<S, R, P> as Sink>::SinkError>[src]
fn poll_flush(
&mut self,
cx: &mut Context
) -> Result<Async<()>, <TakeWhile<S, R, P> as Sink>::SinkError>Flush any remaining output from this sink. Read more
fn poll_close(
&mut self,
cx: &mut Context
) -> Result<Async<()>, <TakeWhile<S, R, P> as Sink>::SinkError>[src]
fn poll_close(
&mut self,
cx: &mut Context
) -> Result<Async<()>, <TakeWhile<S, R, P> as Sink>::SinkError>Flush any remaining output and close this sink, if necessary. Read more
impl<S, R, P> Debug for TakeWhile<S, R, P> where
P: Debug,
R: Debug + IntoFuture,
S: Debug + Stream,
<R as IntoFuture>::Future: Debug,
<S as Stream>::Item: Debug, [src]
impl<S, R, P> Debug for TakeWhile<S, R, P> where
P: Debug,
R: Debug + IntoFuture,
S: Debug + Stream,
<R as IntoFuture>::Future: Debug,
<S as Stream>::Item: Debug, fn fmt(&self, f: &mut Formatter) -> Result<(), Error>[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>Formats the value using the given formatter. Read more
impl<S, R, P> Stream for TakeWhile<S, R, P> where
P: FnMut(&<S as Stream>::Item) -> R,
R: IntoFuture<Item = bool, Error = <S as Stream>::Error>,
S: Stream, [src]
impl<S, R, P> Stream for TakeWhile<S, R, P> where
P: FnMut(&<S as Stream>::Item) -> R,
R: IntoFuture<Item = bool, Error = <S as Stream>::Error>,
S: Stream, type Item = <S as Stream>::Item
Values yielded by the stream.
type Error = <S as Stream>::Error
Errors yielded by the stream.
fn poll_next(
&mut self,
cx: &mut Context
) -> Result<Async<Option<<S as Stream>::Item>>, <S as Stream>::Error>[src]
fn poll_next(
&mut self,
cx: &mut Context
) -> Result<Async<Option<<S as Stream>::Item>>, <S as Stream>::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
Auto Trait Implementations
impl<S, R, P> Send for TakeWhile<S, R, P> where
P: Send,
S: Send,
<R as IntoFuture>::Future: Send,
<S as Stream>::Item: Send,
impl<S, R, P> Send for TakeWhile<S, R, P> where
P: Send,
S: Send,
<R as IntoFuture>::Future: Send,
<S as Stream>::Item: Send, impl<S, R, P> Sync for TakeWhile<S, R, P> where
P: Sync,
S: Sync,
<R as IntoFuture>::Future: Sync,
<S as Stream>::Item: Sync,
impl<S, R, P> Sync for TakeWhile<S, R, P> where
P: Sync,
S: Sync,
<R as IntoFuture>::Future: Sync,
<S as Stream>::Item: Sync, Blanket Implementations
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 Timpl<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 TMutably 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
impl<T> StreamExt for T where
T: Stream + ?Sized, [src]
impl<T> StreamExt for T where
T: Stream + ?Sized, fn next(self) -> StreamFuture<Self>[src]
fn next(self) -> StreamFuture<Self>Converts this stream into a Future. Read more
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> U, [src]
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> U, 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, [src]
fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
F: FnMut(Self::Error) -> U, 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>, [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>, 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>, [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>, 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, [src]
fn then<U, F>(self, f: F) -> Then<Self, U, F> where
F: FnMut(Result<Self::Item, Self::Error>) -> U,
U: IntoFuture, 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>, [src]
fn and_then<U, F>(self, f: F) -> AndThen<Self, U, F> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Error = Self::Error>, 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>, [src]
fn or_else<U, F>(self, f: F) -> OrElse<Self, U, F> where
F: FnMut(Self::Error) -> U,
U: IntoFuture<Item = Self::Item>, Chain on a computation for when an error happens, passing the erroneous result to the provided closure f. Read more
fn collect<C>(self) -> Collect<Self, C> where
C: Default + Extend<Self::Item>, [src]
fn collect<C>(self) -> Collect<Self, C> where
C: Default + Extend<Self::Item>, 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::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator,
Self::Item: Default, [src]
fn concat(self) -> Concat<Self> where
Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator,
Self::Item: 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>, [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>, 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,
<Self::Item as Stream>::Error == Self::Error, [src]
fn flatten(self) -> Flatten<Self> where
Self::Item: Stream,
<Self::Item as Stream>::Error == Self::Error, 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>, [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>, 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>, [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>, 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>, [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>, 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>, [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>, 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::Error: Into<E>, [src]
fn err_into<E>(self) -> ErrInto<Self, E> where
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>[src]
fn take(self, amt: u64) -> Take<Self>Creates a new stream of at most amt items of the underlying stream. Read more
fn skip(self, amt: u64) -> Skip<Self>[src]
fn skip(self, amt: u64) -> Skip<Self>Creates a new stream which skips amt items of the underlying stream. Read more
fn fuse(self) -> Fuse<Self>[src]
fn fuse(self) -> Fuse<Self>Fuse a stream such that poll will never again be called once it has finished. Read more
fn by_ref(&mut self) -> &mut Self[src]
fn by_ref(&mut self) -> &mut SelfBorrows a stream, rather than consuming it. Read more
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe, [src]
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe, Catches unwinding panics while polling the stream. Read more
fn buffered(self, amt: usize) -> Buffered<Self> where
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error, [src]
fn buffered(self, amt: usize) -> Buffered<Self> where
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error, An adaptor for creating a buffered list of pending futures. Read more
fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error, [src]
fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error, 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>, [src]
fn zip<S>(self, other: S) -> Zip<Self, S> where
S: Stream<Error = Self::Error>, 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>, [src]
fn chain<S>(self, other: S) -> Chain<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>, Adapter for chaining two stream. Read more
fn peekable(self) -> Peekable<Self>[src]
fn peekable(self) -> Peekable<Self>Creates a new stream which exposes a peek method. Read more
fn chunks(self, capacity: usize) -> Chunks<Self>[src]
fn chunks(self, capacity: usize) -> Chunks<Self>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>, [src]
fn select<S>(self, other: S) -> Select<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>, 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 as Sink>::SinkError>, [src]
fn forward<S>(self, sink: S) -> Forward<Self, S> where
S: Sink<SinkItem = Self::Item>,
Self::Error: From<<S as Sink>::SinkError>, 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, [src]
fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
Self: Sink, 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), [src]
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item), 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), [src]
fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnMut(&Self::Error), 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>, [src]
fn recover<E, F>(self, f: F) -> Recover<Self, E, F> where
F: FnMut(Self::Error) -> Option<Self::Item>, 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>, [src]
fn left<B>(self) -> Either<Self, B> where
B: Stream<Item = Self::Item, Error = Self::Error>, : 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>, [src]
fn right<B>(self) -> Either<B, Self> where
B: Stream<Item = Self::Item, Error = Self::Error>, : 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>, [src]
fn left_stream<B>(self) -> Either<Self, B> where
B: Stream<Item = Self::Item, Error = Self::Error>, 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>, [src]
fn right_stream<B>(self) -> Either<B, Self> where
B: Stream<Item = Self::Item, Error = Self::Error>, 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 as IntoFuture>::Error: From<Self::SinkError>, [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 as IntoFuture>::Error: From<Self::SinkError>, 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>, [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>, 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, [src]
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::SinkError) -> E, Transforms the error returned by the sink.
fn sink_err_into<E>(self) -> SinkErrInto<Self, E> where
Self::SinkError: Into<E>, [src]
fn sink_err_into<E>(self) -> SinkErrInto<Self, E> where
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>[src]
fn buffer(self, amt: usize) -> Buffer<Self>Adds a fixed-size buffer to the current sink. Read more
fn close(self) -> Close<Self>[src]
fn close(self) -> Close<Self>Close the sink. Read more
fn fanout<S>(self, other: S) -> Fanout<Self, S> where
S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
Self::SinkItem: Clone, [src]
fn fanout<S>(self, other: S) -> Fanout<Self, S> where
S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
Self::SinkItem: Clone, Fanout items to multiple sinks. Read more
fn flush(self) -> Flush<Self>[src]
fn flush(self) -> Flush<Self>Flush the sync, processing all pending items. Read more
fn send(self, item: Self::SinkItem) -> Send<Self>[src]
fn send(self, item: Self::SinkItem) -> Send<Self>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 as Stream>::Error>, [src]
fn send_all<S>(self, stream: S) -> SendAll<Self, S> where
S: Stream<Item = Self::SinkItem>,
Self::SinkError: From<<S as Stream>::Error>, 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>, [src]
fn left_sink<B>(self) -> Either<Self, B> where
B: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>, 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>, [src]
fn right_sink<B>(self) -> Either<B, Self> where
B: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>, Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more