/// Threaded debouncer wrapping `EventBuffer`. Accepts a common delay and a

/// Threaded debouncer wrapping [EventBuffer]. Accepts a common delay and a

/// Threaded debouncer wrapping `MixedEventBuffer`. Accepts a callback function

/// Threaded debouncer wrapping [MixedEventBuffer]. Accepts a callback function

/// The delay is specified separately for each event as an argument to `.put()`.

/// The delay is specified separately for each event as an argument to
/// [MixedEventBuffer::put()].

//! `debounce::buffer` module. A buffer only implements `.put` and `.get`, and

//! [buffer] module. A buffer only implements `.put` and `.get`, and

//! The crate also provides threaded debouncers built on top of the buffers,
//! which is what you probably want to use most of the time.

//! The crate also provides [threaded debouncers](thread) built on top of the
//! buffers, which is what you probably want to use most of the time.

/// Current state of the debouncing buffer returned from `.get()`:

/// Current state of the debouncing buffer returned from [Get::get()]:

    /// ready (`State::Ready`) it's removed from the buffer.

    /// [State::Ready] it's removed from the buffer.

    /// Returns an iterator over all `State::Ready` elements of the buffer.
    /// Stops when either the next element is in (`State::Wait`) or the buffer
    /// is `State::Empty`.

    /// Returns an iterator over all [State::Ready] elements of the buffer.
    /// Stops when either the next element is in [State::Wait] or the buffer
    /// is [State::Empty].

/// Wraps a mutable reference to a buffer and implements an `Iterator` returning
/// elements in `State::Ready`. Commonly instantiated by `buffer.iter()`.

/// Wraps a mutable reference to a buffer and implements an [Iterator] returning
/// elements in [State::Ready]. Commonly instantiated by [Get::iter()].

/// `.put()` which tracks the time of the event and de-duplicates them against
/// the current buffer content. Subsequent call to `.get()` which returns the
/// `State` of the buffer.

/// [EventBuffer::put()] which tracks the time of events and de-duplicates them
/// against the current buffer content. Subsequent call to [EventBuffer::get
/// ()] which returns the [State] of the buffer.

/// Implemented on top of a `VecDeque` and should be slightly more preformant
/// than `MixedEventBuffer`.

/// Implemented on top of a [VecDeque] and should be slightly more preformant
/// than [MixedEventBuffer].

/// Debouncing buffer with per-event delays. Accepts events via `.put(T, delay)`
/// which tracks the time of the event and de-duplicates them against the
/// current buffer content. Subsequent call to `.get()` which returns the
/// `State` of the buffer.

/// Debouncing buffer with per-event delays. Accepts events via
/// [MixedEventBuffer::put()] passing a `delay` as an argument. The call
/// tracks the time of events and de-duplicates them against the current buffer
/// content. Subsequent call to [MixedEventBuffer::get()] which returns the
/// [State] of the buffer.

/// Implemented on top of a `BinaryHeap` and should be slightly less preformant
/// than `EventBuffer`.

/// Implemented on top of a [BinaryHeap] and should be slightly less preformant
/// than [EventBuffer].