Struct PopupPortalOutcome

pub struct PopupPortalOutcome { /* private fields */ }

Result of routing one popup lifecycle or input operation.

handled answers whether the popup authority consumed/recognized the operation; it is independent from whether any intents were emitted. An already-open raise, for example, may be handled with no new intent.

Examples

use ailloli_ui_runtime::popup::PopupPortalOutcome;
let outcome = PopupPortalOutcome::default();
assert!(!outcome.handled() && outcome.intents().is_empty());

Implementations

impl PopupPortalOutcome

Observation and ownership conversion for popup outcomes.

pub const fn handled(&self) -> bool

Reports whether the popup authority handled the operation.

Examples

use ailloli_ui_runtime::popup::{PopupId, PopupPortal};
assert!(!PopupPortal::<()>::new().close(PopupId::new(1)).handled());

pub fn intents(&self) -> &[PopupIntent]

Borrows ordered intents without consuming the outcome.

An empty slice does not imply handled == false.

Examples

use ailloli_ui_runtime::popup::PopupPortalOutcome;
assert_eq!(PopupPortalOutcome::default().intents(), &[]);

pub fn into_intents(self) -> Vec<PopupIntent>

Consumes the outcome and returns its ordered intent vector.

The handled flag is discarded.

Examples

use ailloli_ui_runtime::popup::PopupPortalOutcome;
assert!(PopupPortalOutcome::default().into_intents().is_empty());

Trait Implementations

impl Clone for PopupPortalOutcome

fn clone(&self) -> PopupPortalOutcome

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PopupPortalOutcome

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

Formats the value using the given formatter.

impl Default for PopupPortalOutcome

fn default() -> PopupPortalOutcome

Returns the “default value” for a type.

impl PartialEq for PopupPortalOutcome

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

impl StructuralPartialEq for PopupPortalOutcome