Struct PopupMountRouteOutcome

pub struct PopupMountRouteOutcome { /* private fields */ }

Result of routing an event through the retained popup overlay.

popup_id names the local mount receiving dispatch, if any. consumed tells the host not to route the same event into owner-window content; the nested RouteOutcome independently reports interaction/dispatch effects.

Examples

use ailloli_ui_runtime::popup_mount::PopupMountRouteOutcome;
let outcome = PopupMountRouteOutcome::default();
assert_eq!(outcome.popup_id(), None);
assert!(!outcome.consumed());

Implementations

impl PopupMountRouteOutcome

Observation and redraw interpretation for mount routing.

pub const fn popup_id(&self) -> Option<PopupId>

Returns the popup selected for local dispatch, if any.

Examples

use ailloli_ui_runtime::popup_mount::PopupMountRouteOutcome;
assert!(PopupMountRouteOutcome::default().popup_id().is_none());

pub const fn consumed(&self) -> bool

Whether owner-window content must not receive this event.

Examples

use ailloli_ui_runtime::popup_mount::PopupMountRouteOutcome;
assert!(!PopupMountRouteOutcome::default().consumed());

pub const fn route(&self) -> &RouteOutcome

Borrows aggregated popup-local router effects.

Examples

use ailloli_ui_runtime::popup_mount::PopupMountRouteOutcome;
assert!(!PopupMountRouteOutcome::default().route().event_dispatched);

pub fn needs_redraw(&self) -> bool

Requests redraw when the overlay consumed input or interaction changed.

Event dispatch alone does not imply redraw unless it was also consumed.

Examples

use ailloli_ui_runtime::popup_mount::PopupMountRouteOutcome;
assert!(!PopupMountRouteOutcome::default().needs_redraw());

Trait Implementations

impl Clone for PopupMountRouteOutcome

fn clone(&self) -> PopupMountRouteOutcome

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PopupMountRouteOutcome

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

Formats the value using the given formatter.

impl Default for PopupMountRouteOutcome

fn default() -> PopupMountRouteOutcome

Returns the “default value” for a type.

impl PartialEq for PopupMountRouteOutcome

fn eq(&self, other: &PopupMountRouteOutcome) -> 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 Eq for PopupMountRouteOutcome

impl StructuralPartialEq for PopupMountRouteOutcome