Struct Entity 

pub struct Entity<T> { /* private fields */ }

A strong, well-typed reference to a struct which is managed by GPUI

Implementations

impl<T: 'static> Entity<T>

pub fn entity_id(&self) -> EntityId

Get the entity ID associated with this entity

pub fn downgrade(&self) -> WeakEntity<T>

Downgrade this entity pointer to a non-retaining weak pointer

pub fn into_any(self) -> AnyEntity

Convert this into a dynamically typed entity.

pub fn read<'a>(&self, cx: &'a App) -> &'a T

Grab a reference to this entity from the context.

pub fn read_with<R, C: AppContext>( &self, cx: &C, f: impl FnOnce(&T, &App) -> R, ) -> C::Result<R>

Read the entity referenced by this handle with the given function.

pub fn update<R, C: AppContext>( &self, cx: &mut C, update: impl FnOnce(&mut T, &mut Context<'_, T>) -> R, ) -> C::Result<R>

Updates the entity referenced by this handle with the given function.

pub fn as_mut<'a, C: AppContext>( &self, cx: &'a mut C, ) -> C::Result<GpuiBorrow<'a, T>>

Updates the entity referenced by this handle with the given function.

pub fn write<C: AppContext>(&self, cx: &mut C, value: T) -> C::Result<()>

Updates the entity referenced by this handle with the given function.

pub fn update_in<R, C: VisualContext>( &self, cx: &mut C, update: impl FnOnce(&mut T, &mut Window, &mut Context<'_, T>) -> R, ) -> C::Result<R>

Updates the entity referenced by this handle with the given function if the referenced entity still exists, within a visual context that has a window. Returns an error if the entity has been released.

Methods from Deref<Target = AnyEntity>

pub fn entity_id(&self) -> EntityId

Returns the id associated with this entity.

pub fn entity_type(&self) -> TypeId

Returns the TypeId associated with this entity.

pub fn downgrade(&self) -> AnyWeakEntity

Converts this entity handle into a weak variant, which does not prevent it from being released.

Trait Implementations

impl<T> Clone for Entity<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Entity<T>

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

Formats the value using the given formatter.

impl<T> Deref for Entity<T>

type Target = AnyEntity

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Entity<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<V: Render> Element for Entity<V>

type RequestLayoutState = AnyElement

The type of state returned from Element::request_layout. A mutable reference to this state is subsequently provided to Element::prepaint and Element::paint.

type PrepaintState = ()

The type of state returned from Element::prepaint. A mutable reference to this state is subsequently provided to Element::paint.

fn id(&self) -> Option<ElementId>

If this element has a unique identifier, return it here. This is used to track elements across frames, and will cause a GlobalElementId to be passed to the request_layout, prepaint, and paint methods.

fn source_location(&self) -> Option<&'static Location<'static>>

Source location where this element was constructed, used to disambiguate elements in the inspector and navigate to their source code.

fn request_layout( &mut self, _id: Option<&GlobalElementId>, _inspector_id: Option<&InspectorElementId>, window: &mut Window, cx: &mut App, ) -> (LayoutId, Self::RequestLayoutState)

Before an element can be painted, we need to know where it’s going to be and how big it is. Use this method to request a layout from Taffy and initialize the element’s state.

fn prepaint( &mut self, _id: Option<&GlobalElementId>, _inspector_id: Option<&InspectorElementId>, _: Bounds<Pixels>, element: &mut Self::RequestLayoutState, window: &mut Window, cx: &mut App, )

After laying out an element, we need to commit its bounds to the current frame for hitbox purposes. The state argument is the same state that was returned from Element::request_layout().

fn paint( &mut self, _id: Option<&GlobalElementId>, _inspector_id: Option<&InspectorElementId>, _: Bounds<Pixels>, element: &mut Self::RequestLayoutState, _: &mut Self::PrepaintState, window: &mut Window, cx: &mut App, )

Once layout has been completed, this method will be called to paint the element to the screen. The state argument is the same state that was returned from Element::request_layout().

fn into_any(self) -> AnyElement

Convert this element into a dynamically-typed AnyElement.

impl<V: Focusable> Focusable for Entity<V>

fn focus_handle(&self, cx: &App) -> FocusHandle

Returns the focus handle associated with this view.

impl<I: ImageCache> From<Entity<I>> for AnyImageCache

fn from(image_cache: Entity<I>) -> Self

Converts to this type from the input type.

impl<T> From<Entity<T>> for AnyEntity

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

Converts to this type from the input type.

impl<V: Render> From<Entity<V>> for AnyView

fn from(value: Entity<V>) -> Self

Converts to this type from the input type.

impl<T> Hash for Entity<T>

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<T: ImageCache> ImageCacheProvider for Entity<T>

fn provide(&mut self, _window: &mut Window, _cx: &mut App) -> AnyImageCache

Called during the request_layout phase to create an ImageCache.

impl<V: 'static + Render> IntoElement for Entity<V>

type Element = Entity<V>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl<T: 'static> Ord for Entity<T>

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.

impl<T> PartialEq<Entity<T>> for WeakEntity<T>

fn eq(&self, other: &Entity<T>) -> 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<T> PartialEq<WeakEntity<T>> for Entity<T>

fn eq(&self, other: &WeakEntity<T>) -> 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<T> PartialEq for Entity<T>

fn eq(&self, other: &Self) -> 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<T: 'static> PartialOrd for Entity<T>

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.

impl<T: UniformListDecoration + 'static> UniformListDecoration for Entity<T>

fn compute( &self, visible_range: Range<usize>, bounds: Bounds<Pixels>, scroll_offset: Point<Pixels>, item_height: Pixels, item_count: usize, window: &mut Window, cx: &mut App, ) -> AnyElement

Compute the decoration element, given the visible range of list items, the bounds of the list, and the height of each item.

impl<T> Eq for Entity<T>