Skip to main content

AttentionPolicy

Struct AttentionPolicy 

Source
pub struct AttentionPolicy { /* private fields */ }
Expand description

What an integrator asked to be told about, and how insistently.

Implementations§

Source§

impl AttentionPolicy

Source

pub fn new( kinds: impl IntoIterator<Item = AttentionKind>, coalesce_window: DurationMs, max_queued: QueueLimit, overflow: AttentionOverflowPolicy, inactivity_after: Option<DurationMs>, limits: LoopLimits, ) -> Result<Self, DomainError>

Construct a validated policy.

An empty selection is refused rather than silently meaning “everything”: a binding that asked for nothing and is woken for everything is the kind of surprise a policy exists to prevent.

Source

pub fn admits(&self, kind: AttentionKind) -> bool

Whether this policy asked to hear about that kind.

Source

pub const fn kinds(&self) -> &BTreeSet<AttentionKind>

Source

pub const fn coalesce_window(&self) -> DurationMs

How long two restless events of one kind are folded into one.

Source

pub const fn coalesces(kind: AttentionKind) -> bool

Whether this kind is one the window applies to at all.

Coalescing a result or a decision would lose one; only the kinds that repeat while nothing changes are folded.

Source

pub const fn max_queued(&self) -> QueueLimit

Source

pub const fn overflow(&self) -> AttentionOverflowPolicy

Source

pub const fn inactivity_after(&self) -> Option<DurationMs>

How long nothing may happen before the quiet is itself reported.

Source

pub const fn limits(&self) -> LoopLimits

Trait Implementations§

Source§

impl Clone for AttentionPolicy

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 Debug for AttentionPolicy

Source§

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

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

impl Default for AttentionPolicy

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for AttentionPolicy

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for AttentionPolicy

Source§

impl PartialEq for AttentionPolicy

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 Serialize for AttentionPolicy

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for AttentionPolicy

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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> Same for T

Source§

type Output = T

Should always be Self
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.