futures_util/stream/take.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
use futures_core::{Async, Poll, Stream};
use futures_core::task;
use futures_sink::{ Sink};
/// A stream combinator which returns a maximum number of elements.
///
/// This structure is produced by the `Stream::take` method.
#[derive(Debug)]
#[must_use = "streams do nothing unless polled"]
pub struct Take<S> {
stream: S,
remaining: u64,
}
pub fn new<S>(s: S, amt: u64) -> Take<S>
where S: Stream,
{
Take {
stream: s,
remaining: amt,
}
}
impl<S> Take<S> {
/// Acquires a reference to the underlying stream that this combinator is
/// pulling from.
pub fn get_ref(&self) -> &S {
&self.stream
}
/// 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_mut(&mut self) -> &mut S {
&mut self.stream
}
/// 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.
pub fn into_inner(self) -> S {
self.stream
}
}
// Forwarding impl of Sink from the underlying stream
impl<S> Sink for Take<S>
where S: Sink + Stream
{
type SinkItem = S::SinkItem;
type SinkError = S::SinkError;
delegate_sink!(stream);
}
impl<S> Stream for Take<S>
where S: Stream,
{
type Item = S::Item;
type Error = S::Error;
fn poll_next(&mut self, cx: &mut task::Context) -> Poll<Option<S::Item>, S::Error> {
if self.remaining == 0 {
Ok(Async::Ready(None))
} else {
let next = try_ready!(self.stream.poll_next(cx));
match next {
Some(_) => self.remaining -= 1,
None => self.remaining = 0,
}
Ok(Async::Ready(next))
}
}
}