Struct sixtyfps::Weak

pub struct Weak<T: ComponentHandle> { /* fields omitted */ }

Struct that’s used to hold weak references of SixtyFPS component

In order to create a Weak, you should use ComponentHandle::as_weak.

Strong references should not be captured by the functions given to a lambda, as this would produce a reference loop and leak the component. Instead, the callback function should capture a weak component.

The Weak component also implement Send and can be send to another thread. but the upgrade function will only return a valid component from the same thread as the one it has been created from. This is useful to use with invoke_from_event_loop().

Implementations

impl<T: ComponentHandle> Weak<T>

pub fn upgrade(&self) -> Option<T> where
    T: ComponentHandle, 

Returns a new strongly referenced component if some other instance still holds a strong reference. Otherwise, returns None.

This also returns None if the current thread is not the thread that created the component

pub fn unwrap(&self) -> T

Convenience function that returns a new strongly referenced component if some other instance still holds a strong reference and the current thread is the thread that created this component. Otherwise, this function panics.

Trait Implementations

impl<T: ComponentHandle> Clone for Weak<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: ComponentHandle> Send for Weak<T>