Enum Consumed 

#[non_exhaustive]
pub enum Consumed {
    No,
    Yes,
}

Whether an Interaction claimed an event.

Reported by handle_event, so a caller with more than one interaction context (a menu bar above a screen stack, a dropdown above a form) knows whether to keep routing the same event further down. A coarse substitute, like “is the menu currently open”, answers a different and less useful question: it stays true for events the menu doesn’t care about (Resize, Paste, a key it doesn’t bind), and it depends on the caller keeping that flag in sync with state that can change out from under it (closing the menu without also clearing the flag). Consumed instead reports, per event, whether this call actually used it.

Variants (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.

No

Nothing here claimed the event: keep routing it to whatever’s behind this interaction.

Yes

This interaction claimed the event: stop routing it further.

Implementations

impl Consumed

pub const fn is_yes(self) -> bool

true for Consumed::Yes.

pub const fn is_no(self) -> bool

true for Consumed::No.

Trait Implementations

impl Clone for Consumed

fn clone(&self) -> Consumed

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Consumed

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

Formats the value using the given formatter.

impl From<bool> for Consumed

fn from(consumed: bool) -> Self

true becomes Consumed::Yes, false becomes Consumed::No.

impl PartialEq for Consumed

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Consumed

impl Eq for Consumed

impl StructuralPartialEq for Consumed