Struct Entity 

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

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

Implementations

impl<T> Entity<T>

where T: 'static,

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>(&self, cx: &C, f: impl FnOnce(&T, &App) -> R) -> R

where C: AppContext,

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

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

where C: AppContext,

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

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

where C: AppContext,

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

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

where C: AppContext,

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

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

where C: VisualContext,

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 window has been closed.

impl<T> Entity<T>

where T: Render,

pub fn cached(self, style: StyleRefinement) -> ViewElement<Entity<T>>

Embed this entity as a cached [ViewElement] laid out at style.

The rendered subtree is reused until the entity is notified (or the cached bounds / text style change). Caching requires a definite size: a cached view is laid out from style and is not measured from its contents. Use [ViewElement::new] (or .child(entity)) for the uncached case.

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) -> Entity<T>

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<(), Error>

Formats the value using the given formatter.

impl<T> Deref for Entity<T>

type Target = AnyEntity

The resulting type after dereferencing.

fn deref(&self) -> &<Entity<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for Entity<T>

fn deref_mut(&mut self) -> &mut <Entity<T> as Deref>::Target

Mutably dereferences the value.

impl<T> Eq for Entity<T>

impl<V> Focusable for Entity<V>

where V: Focusable,

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

Returns the focus handle associated with this view.

impl<T> From<&(dyn PanelView + 'static)> for Entity<T>

where T: Panel,

fn from(value: &(dyn PanelView + 'static)) -> Entity<T>

Converts to this type from the input type.

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

where I: ImageCache,

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

where V: Render,

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

Converts to this type from the input type.

impl<T> Hash for Entity<T>

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

where T: ImageCache,

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

Called during the request_layout phase to create an ImageCache.

impl<V> IntoElement for Entity<V>

where V: 'static + Render,

type Element = ViewElement<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) -> <Entity<V> as IntoElement>::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl<T> Ord for Entity<T>

where T: 'static,

fn cmp(&self, other: &Entity<T>) -> 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<T> PanelView for Entity<T>

where T: Panel,

fn panel_name(&self, cx: &App) -> &'static str

fn panel_id(&self, _: &App) -> PanelId

fn closable(&self, cx: &App) -> bool

fn zoomable(&self, cx: &App) -> bool

fn visible(&self, cx: &App) -> bool

fn set_active(&self, active: bool, window: &mut Window, cx: &mut App)

fn set_zoomed(&self, zoomed: bool, window: &mut Window, cx: &mut App)

fn on_added_to( &self, group: WeakEntity<TabGroup>, window: &mut Window, cx: &mut App, )

fn on_removed(&self, window: &mut Window, cx: &mut App)

fn view(&self) -> AnyView

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

fn dump(&self, cx: &App) -> PanelState

fn as_any(&self) -> &(dyn Any + 'static)

The concrete value behind this handle.

impl<T> PanelView for Entity<T>

where T: Panel,

fn tab_name(&self, cx: &App) -> Option<SharedString>

fn title(&self, window: &mut Window, cx: &mut App) -> AnyElement

fn title_style(&self, cx: &App) -> Option<TitleStyle>

fn title_suffix(&self, window: &mut Window, cx: &mut App) -> Option<AnyElement>

fn toolbar_buttons( &self, window: &mut Window, cx: &mut App, ) -> Option<Vec<Button>>

fn dropdown_menu( &self, menu: PopupMenu, window: &mut Window, cx: &mut App, ) -> PopupMenu

fn zoom_control(&self, cx: &App) -> Option<PanelControl>

fn inner_padding(&self, cx: &App) -> bool

impl<T> PartialEq for Entity<T>

fn eq(&self, other: &Entity<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

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

fn eq(&self, other: &Entity<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

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

fn eq(&self, other: &WeakEntity<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T> PartialOrd for Entity<T>

where T: 'static,

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

where T: UniformListDecoration + 'static,

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> View for Entity<T>

where T: Render,

An entity that renders itself (Render) is a View keyed on its own id.

fn entity_id(&self) -> Option<EntityId>

This view’s identity, if it has one. A view typically holds the backing entity as a field and returns its EntityId here.

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this view into an element tree, consuming self.