Skip to main content

Debounce

Enum Debounce 

Source
#[non_exhaustive]
pub enum Debounce { Inherit, Off, Custom(DebounceConfig), }
Expand description

A subscription’s debounce posture, resolved against the watcher-global default (TributariesOptions::debounce) at delivery time.

Carried per watch on WatchOptions::with_debounce, it makes disabled-vs-inherit-vs-custom a first-class three-way state: Off can switch settling off for one subscription while the global coalescer stays on, and Custom can switch it on (with its own windows) while the global default is off — neither expressible with a bare Option<DebounceConfig>.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Inherit

Follow the watcher-global policy (TributariesOptions::debounce) — the default.

§

Off

Raw pass-through for this subscription, even when the watcher-global coalescer is on: its events ride through undelayed and uncollapsed, in admission order.

§

Custom(DebounceConfig)

This subscription’s own settle policy, overriding the watcher-global default — including enabling settling when the watcher-global debounce is off (which instantiates the coalescer on first use).

Implementations§

Source§

impl Debounce

Source

pub const fn is_inherit(&self) -> bool

Whether this is Inherit — follow the watcher-global policy.

Source

pub const fn is_off(&self) -> bool

Whether this is Off — raw pass-through for this subscription.

Source

pub const fn is_custom(&self) -> bool

Whether this is Custom — the subscription’s own settle policy.

Source

pub const fn as_custom(&self) -> Option<&DebounceConfig>

The subscription’s own settle policy, when this is Custom.

Trait Implementations§

Source§

impl Clone for Debounce

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for Debounce

Source§

impl Debug for Debounce

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Debounce

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for Debounce

Source§

impl PartialEq for Debounce

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Debounce

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.