Struct AnyWeakEntity 

pub struct AnyWeakEntity { /* private fields */ }

A type-erased handle to an entity that doesn’t keep it alive.

Upgrade it with AnyWeakEntity::upgrade to get a strong AnyEntity while the entity exists.

Implementations

impl AnyWeakEntity

pub fn entity_id(&self) -> EntityId

Returns the id of the entity this handle refers to.

pub fn is_upgradable(&self) -> bool

Returns whether AnyWeakEntity::upgrade would succeed now.

Returns false once the last strong handle has been dropped, even before GPUI has released the entity.

pub fn upgrade(&self) -> Option<AnyEntity>

Returns a strong handle to the entity, or None if it has been released.

An entity whose last strong handle was dropped in the current update already returns None.

pub fn assert_released(&self)

Asserts that the entity this handle refers to has been released.

Use this in tests to find a strong handle that was leaked. A task or a subscription that still holds a strong handle makes the check fail. The check needs the leak detector, which is enabled in tests and with the leak-detection feature.

GPUI releases an entity when the update that dropped its last handle finishes. Run an update before you call this, as the example does.

Examples

let document = app.update(|cx| cx.new(|_cx| Document));
let weak = document.downgrade();
drop(document);

// The update finishes, and GPUI releases the entity.
app.update(|_cx| {});
weak.assert_released();

Debugging Leaks

If this method panics because of a leaked handle, set the LEAK_BACKTRACE environment variable to see where the handle was created: With leak detection enabled (build with GPUI_LEAK_DETECTION=1), a failure lists each leaked handle. Also set the LEAK_BACKTRACE environment variable to see where they were allocated:

GPUI_LEAK_DETECTION=1 LEAK_BACKTRACE=1 cargo test my_test

Panics

• Panics if any strong handles to the entity are still alive.
• Panics if the entity was dropped in the current update. Its resources are kept until that update finishes.

pub fn new_invalid() -> Self

Returns a weak handle that never upgrades. Use it as a placeholder until you have a real entity.

Trait Implementations

impl Clone for AnyWeakEntity

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnyWeakEntity

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

Formats the value using the given formatter.

impl Eq for AnyWeakEntity

impl<T> From<WeakEntity<T>> for AnyWeakEntity

fn from(entity: WeakEntity<T>) -> Self

Converts to this type from the input type.

impl Hash for AnyWeakEntity

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

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 Ord for AnyWeakEntity

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for AnyWeakEntity

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for AnyWeakEntity

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.