[go: up one dir, main page]

futures-time 0.1.0

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

//! Async time combinators
//!
//! # Deadlines and Boundaries
//!
//! While time is the most common type to use as an event source, other sources
//! of events also exist. In order to enable this, all functions take a generic
//! of either `Deadline` or `Boundary`.
//!
//! - `Deadline` represents a specific one-off event. Types which implement
//!   `Deadline` are `std::time::Instant` and `Future`.
//! - `Boundary` represents a range. Types which implement `Boundary` are `Duration`,
//!   and `Stream`.
//!
//! # Futures
//! - [`task::sleep`] Sleeps for the specified amount of time.
//! - [`Future::delay`](`future::FutureExt::delay`) Delay execution for a specified time.
//! - [`Future::delay_until`](`future::FutureExt::delay_until`) Delay execution until the specified instant.
//! - [`Future::timeout`](`future::FutureExt::timeout`) Cancel the future if the execution takes longer than the specified time.
//! - [`Future::timeout_at`](`future::FutureExt::timeout_at`) Cancel the future if the execution goes beyond the specified instant.
//!
//! # Streams
//!
//! - [`stream::interval`](`stream::interval`) Creates a new stream that yields at a set interval.
//! - `Stream::audit`
//! - `Stream::buffer`
//! - [`Stream::debounce`](`stream::StreamExt::debounce`)
//! - [`Stream::delay`](`stream::StreamExt::delay`) Delay execution for a specified time.
//! - [`Stream::delay_until`](`stream::StreamExt::delay_until`) Delay execution until the specified instant.
//! - `Stream::sample`
//! - [`Stream::throttle`](`stream::StreamExt::throttle`) Filter out all items after the first for a specified time.
//! - [`Stream::timeout`](`stream::StreamExt::timeout`) Cancel the stream if the execution takes longer than the specified time.
//! - [`Stream::timeout_at`](`stream::StreamExt::timeout_at`) Cancel the stream if the execution goes beyond the specified instant.

#![forbid(unsafe_code)]
#![deny(missing_debug_implementations)]
#![warn(missing_docs, future_incompatible, unreachable_pub)]

pub(crate) mod utils;

/// `std::stream` extensions.
pub mod stream;

/// `std::task` extensions.
pub mod task;

/// `std::future` extensions.
pub mod future;

/// The `futures-time` prelude.
pub mod prelude {
    pub use super::future::FutureExt as _;
    pub use super::stream::StreamExt as _;
}