Struct Debounce 

pub struct Debounce<S: Stream> { /* private fields */ }

A stream that debounces items, emitting only after a quiet period.

Created by StreamExt::debounce.

When the underlying stream produces an item, it is buffered. If no new item arrives for period, the buffered item is yielded. Each new item replaces the buffered value and resets the timer.

When the underlying stream ends, any buffered item is flushed immediately.

Note

By default this combinator uses the runtime wall clock via crate::time::wall_now, but tests and adapters can override that with Debounce::with_time_getter. The combinator still arms an internal Sleep so the executor gets a real wakeup when the quiet period expires, while readiness decisions continue to use the configured time getter.

Implementations

impl<S: Stream> Debounce<S>

pub fn with_time_getter( stream: S, period: Duration, time_getter: fn() -> Time, ) -> Self

Creates a new Debounce stream with a custom time source.

pub fn get_ref(&self) -> &S

Returns a reference to the underlying stream.

pub fn get_mut(&mut self) -> &mut S

Returns a mutable reference to the underlying stream.

pub fn into_inner(self) -> S

Consumes the combinator, returning the underlying stream.

pub const fn time_getter(&self) -> fn() -> Time

Returns the configured time source.

Trait Implementations

impl<S: Stream + Debug> Debug for Debounce<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S: Stream> Stream for Debounce<S>

type Item = <S as Stream>::Item

The type of values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<S::Item>>

Attempt to pull out the next value of this stream.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'pin, S: Stream> Unpin for Debounce<S>

where PinnedFieldsOf<__Debounce<'pin, S>>: Unpin,