[][src]Struct tokio_timer::throttle::Throttle

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

Slow down a stream by enforcing a delay between items.

Methods

impl<T> Throttle<T>[src]

pub fn new(stream: T, duration: Duration) -> Self[src]

Slow down a stream by enforcing a delay between items.

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

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

pub fn get_mut(&mut self) -> &mut T[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) -> T[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<T: Debug> Debug for Throttle<T>[src]

impl<T: Stream> Stream for Throttle<T>[src]

type Item = T::Item

The type of item this stream will yield on success.

type Error = ThrottleError<T::Error>

The type of error this stream may generate.

Auto Trait Implementations

impl<T> Send for Throttle<T> where
    T: Send

impl<T> Unpin for Throttle<T> where
    T: Unpin

impl<T> Sync for Throttle<T> where
    T: Sync

impl<T> !UnwindSafe for Throttle<T>

impl<T> !RefUnwindSafe for Throttle<T>

Blanket Implementations

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

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> 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]