Home Explore Blog CI



zed

crates/gpui/docs/contexts.md
80dade8780e58df4490c5fe1720d0fcfb5971d0a051a70a500000003000008c6
# Contexts

GPUI makes extensive use of _context parameters_ (typically named `cx`) to provide access to application state and services. These contexts are references passed to functions, enabling interaction with global state, windows, entities, and system services.

---

## `App`

The root context granting access to the application's global state. This context owns all entities' data and can be used to read or update the data referenced by an `Entity<T>`.

## `Context<T>`

A context provided when interacting with an `Entity<T>`, with additional methods related to that specific entity such as notifying observers and emitting events. This context dereferences into `App`, meaning any function which can take an `App` reference can also take a `Context<T>` reference, allowing you to access the application's global state.

## `AsyncApp` and `AsyncWindowContext`

Whereas the above contexts are always passed to your code as references, you can call `to_async` on the reference to create an async context, which has a static lifetime and can be held across `await` points in async code. When you interact with entities with an async context, the calls become fallible, because the context may outlive the window or even the app itself.

## `TestAppContext`

These are similar to the async contexts above, but they panic if you attempt to access a non-existent app or window, and they also contain other features specific to tests.

---

# Non-Context Core Types

## `Window`

Provides access to the state of an application window. This type has a root view (an `Entity` implementing `Render`) which it can read/update, but since it is not a context, you must pass a `&amp;mut App` (or a context which dereferences to it) to do so, along with other functions interacting with global state. You can obtain a `Window` from an `WindowHandle` by calling `WindowHandle::update`.

## `Entity<T>`

A handle to a structure requiring state. This data is owned by the `App` and can be accessed and modified via references to contexts. If `T` implements `Render`, then the entity is sometimes referred to as a view. Entities can be observed by other entities and windows, allowing a closure to be called when `notify` is called on the entity's `Context`.

Chunks
4651766a (1st chunk of `crates/gpui/docs/contexts.md`)
Title: Context Parameters and Core Types in GPUI
Summary
GPUI uses context parameters like `App`, `Context<T>`, `AsyncApp`, `AsyncWindowContext`, and `TestAppContext` to provide access to application state and services. These contexts enable interaction with global state, windows, entities, and system services. Additionally, GPUI includes non-context core types like `Window` and `Entity<T>`, which provide access to window state and structures requiring state, respectively. Accessing and modifying entity data requires references to contexts.