futures-time 0.1.1

async time combinators
Documentation 
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

use std::time::{Duration, Instant};

use futures_core::Stream;

use super::{Debounce, Delay, DelayUntil, Throttle, Timeout, TimeoutAt};

/// Extend `Stream` with time-based operations.
pub trait StreamExt: Stream {
    /// Returns a stream that debounces for the given boundary.
    fn debounce(self, boundary: Duration) -> Debounce<Self>
    where
        Self: Sized,
    {
        Debounce::new(self, boundary)
    }

    /// Returns a stream that delays execution for a specified duration.
    fn delay(self, boundary: Duration) -> Delay<Self>
    where
        Self: Sized,
    {
        Delay::new(self, boundary)
    }

    /// Returns a stream that delays execution until a specified deadline.
    fn delay_until(self, deadline: Instant) -> DelayUntil<Self>
    where
        Self: Sized,
    {
        DelayUntil::new(self, deadline)
    }

    /// Throtlle a stream.
    fn throttle(self, boundary: Duration) -> Throttle<Self>
    where
        Self: Sized,
    {
        Throttle::new(self, boundary)
    }

    /// Await a stream or times out after a duration of time.     
    fn timeout(self, boundary: Duration) -> Timeout<Self>
    where
        Self: Sized,
    {
        Timeout::new(self, boundary)
    }

    /// Await a stream or time out at the given deadline.
    fn timeout_at(self, deadline: Instant) -> TimeoutAt<Self>
    where
        Self: Sized,
    {
        TimeoutAt::new(self, deadline)
    }
}

impl<S> StreamExt for S where S: Stream {}