Struct OverlayGuard 

pub struct OverlayGuard { /* private fields */ }

RAII owner of a shown overlay entry.

Dropping the guard dismisses the entry, so callers can’t leak entries by forgetting dismiss or mismatching a 0-sentinel id. The typical shape is a remember-ed RefCell<Option<OverlayGuard>>: set it to Some when the overlay should show, back to None to hide.

The guard holds only the handle + id (no entry content), so it never participates in reference cycles with the overlay state.

Implementations

impl OverlayGuard

pub fn show( handle: &OverlayHandle, builder: Rc<dyn Fn() -> View>, z_index: f32, pass_through: bool, ) -> Self

Show builder on handle and own the resulting entry.

pub fn show_with_back( handle: &OverlayHandle, builder: Rc<dyn Fn() -> View>, z_index: f32, pass_through: bool, back_handler: BackHandler, ) -> Self

pub fn id(&self) -> Option<u64>

Entry id, or None after dismiss.

pub fn dismiss(self)

Dismiss now instead of at drop. Consuming the guard makes a double-dismiss impossible.

Trait Implementations

impl Drop for OverlayGuard

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.