Struct AnyView 

pub struct AnyView { /* private fields */ }

A type-erased handle to a view.

It pairs an Entity with its render function, so a field or collection can hold views of different types. Convert an entity with AnyView::from or .into(), and recover its type with AnyView::downcast. An AnyView can be a child wherever a view is accepted. Two AnyViews compare equal when they refer to the same entity.

Example

use gpui::{AnyView, Context, Render, TestApp, Window, div, prelude::*};

struct First;
struct Second;

impl Render for First {
    fn render(&mut self, _window: &mut Window, _cx: &mut Context<Self>) -> impl IntoElement {
        div().child("First")
    }
}

impl Render for Second {
    fn render(&mut self, _window: &mut Window, _cx: &mut Context<Self>) -> impl IntoElement {
        div().child("Second")
    }
}

let mut app = TestApp::new();
let (first, second) = app.update(|cx| (cx.new(|_| First), cx.new(|_| Second)));
let views: Vec<AnyView> = vec![first.into(), second.into()];

assert!(views[0].clone().downcast::<First>().is_ok());
assert!(views[1].clone().downcast::<First>().is_err());

Implementations

impl AnyView

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

Returns this view as an element with a fixed root layout style.

GPUI can reuse the rendered subtree while the view’s entity, tracked entity and global reads, and layout environment remain unchanged. Reads made by nested views and deferred prepaint or paint work are tracked too. A notification to a tracked entity, a tracked global revision change, or Window::refresh causes the view to rebuild. Changes to bounds or inherited layout and paint state can also require fresh output.

style sets the retained root’s layout style. Pass the entity directly as a child when it should keep its natural layout. See Entity::cached and retained view rendering.

pub fn downgrade(&self) -> AnyWeakView

Returns a weak handle to this view. The weak handle doesn’t keep the view alive.

Call AnyWeakView::upgrade on it to get an AnyView back, or None once the view has been dropped.

pub fn downcast<T: 'static>(self) -> Result<Entity<T>, Self>

Converts this handle into an Entity of type T.

Returns Err with the unchanged AnyView when the view isn’t a T.

pub fn entity_type(&self) -> TypeId

Returns the TypeId of the view’s type.

pub fn entity_id(&self) -> EntityId

Returns the EntityId of the entity that backs this view.

Trait Implementations

impl Clone for AnyView

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 AnyView

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

Formats the value using the given formatter.

impl Eq for AnyView

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

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

Converts to this type from the input type.

impl IntoElement for AnyView

type Element = ViewElement<AnyView>

The element type that this type converts into.

fn into_element(self) -> Self::Element

Converts self into an Element.

fn into_any_element(self) -> AnyElement

Converts self into an AnyElement, with its concrete type erased.

impl PartialEq for AnyView

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

Equality operator ==.

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

Inequality operator !=.

impl View for AnyView

AnyView is the type-erased View. Its render is a function pointer rather than a concrete type, so it takes part in the reactive graph like any other view, with the same identity as its entity.

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

Returns the entity that identifies this view, or None for a stateless view.

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

Renders this view into elements. Takes self by value, so the view is used up.