Struct AnyWindowHandle 

pub struct AnyWindowHandle { /* private fields */ }

A handle to a window with any root view type, which can be downcast to a window with a specific root view type.

Implementations

impl AnyWindowHandle

pub fn window_id(&self) -> WindowId

Get the ID of this window.

pub fn metrics(&self, cx: &App) -> Option<WindowMetricsHandle>

A handle for reading this window’s metrics without borrowing it.

Returns None if the window has been closed. Unlike WindowHandle::is_active, this needs only a shared borrow of the app and reads the last published snapshot, so it succeeds even while the window is borrowed and never blocks on the UI thread.

pub fn root_entity_type_name(&self) -> &'static str

Returns the name of the window’s declared root entity type.

pub fn downcast<T>(&self) -> Option<WindowHandle<T>>

where T: 'static,

Attempt to convert this handle to a window handle with a specific root view type. If the types do not match, this will return None.

pub fn update<C, R>( self, cx: &mut C, update: impl FnOnce(AnyView, &mut Window<'_>, &mut App) -> R, ) -> Result<R, Error>

where C: AppContext,

Updates the state of the root view of this window.

This will fail if the window has been closed.

pub fn read<T, C, R>( self, cx: &C, read: impl FnOnce(Entity<T>, &App) -> R, ) -> Result<R, Error>

where C: AppContext, T: 'static,

Read the state of the root view of this window.

This will fail if the window has been closed.

Trait Implementations

impl Clone for AnyWindowHandle

fn clone(&self) -> AnyWindowHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AnyWindowHandle

impl Debug for AnyWindowHandle

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

Formats the value using the given formatter.

impl Eq for AnyWindowHandle

impl<V> From<WindowHandle<V>> for AnyWindowHandle

where V: 'static,

fn from(val: WindowHandle<V>) -> AnyWindowHandle

Converts to this type from the input type.

impl Hash for AnyWindowHandle

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AnyWindowHandle

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AnyWindowHandle