[][src]Struct futures::stream::Take

#[must_use = "streams do nothing unless polled"]
pub struct Take<S> { /* fields omitted */ }

A stream combinator which returns a maximum number of elements.

This structure is produced by the Stream::take method.

Methods

impl<S> Take<S>[src]

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

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

pub fn get_mut(&mut self) -> &mut S[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 into_inner(self) -> S[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<S> Stream for Take<S> where
    S: Stream
[src]

type Item = S::Item

The type of item this stream will yield on success.

type Error = S::Error

The type of error this stream may generate.

impl<S> Sink for Take<S> where
    S: Sink + Stream
[src]

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.

impl<S: Debug> Debug for Take<S>[src]

Auto Trait Implementations

impl<S> Unpin for Take<S> where
    S: Unpin

impl<S> Send for Take<S> where
    S: Send

impl<S> Sync for Take<S> where
    S: Sync

impl<S> UnwindSafe for Take<S> where
    S: UnwindSafe

impl<S> RefUnwindSafe for Take<S> where
    S: RefUnwindSafe

Blanket Implementations

impl<T> From<T> for 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> Into<U> for T where
    U: From<T>, 
[src]

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> Borrow<T> for T where
    T: ?Sized
[src]

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

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