Struct ScriptViewHandle 

pub struct ScriptViewHandle(/* private fields */);

Implementations

impl ScriptViewHandle

pub fn view_id(&self) -> &str

pub fn state(&self) -> ScriptViewState

pub fn theme(&self) -> Result<ThemeHandle, ScriptViewError>

Return a read-only, observable handle to this view’s effective theme.

Errors

Returns ScriptViewError::DisposedView after explicit disposal.

pub fn theme_snapshot(&self, cx: &App) -> Result<ThemeSnapshot, ScriptViewError>

Read this view’s latest effective theme without invoking Rhai.

Errors

Returns ScriptViewError::DisposedView after explicit disposal.

pub fn select_theme( &self, family: &str, variant: &str, cx: &mut App, ) -> Result<bool, ScriptViewError>

Select this view’s app-level theme from trusted Host code.

Errors

Returns after disposal or when the requested theme is unavailable.

pub fn select_locale( &self, locale: &str, cx: &mut App, ) -> Result<bool, ScriptViewError>

Select this view’s app-level locale from trusted Host code.

Errors

Returns after disposal or when the requested locale is unavailable.

pub fn set_motion_preference( &self, preference: MotionPreference, cx: &mut App, ) -> Result<bool, ScriptViewError>

Replace this view’s Host-owned motion preference without resetting state.

Errors

Returns after disposal.

pub fn root(&self, cx: &App) -> Result<Option<UiNode>, ScriptViewError>

Return the latest rendered declarative root.

Errors

Returns ScriptViewError::DisposedView after disposal. Return the last successfully committed declarative tree.

A failed render deliberately preserves this last-good tree. Pair this method with Self::last_error when the caller must distinguish a current successful tree from a rollback after failure.

pub fn last_error(&self, cx: &App) -> Result<Option<String>, ScriptViewError>

Return the latest mounted-view render, callback, delivery, or reload error.

Errors remain available while the last-good tree continues to render. A later successful script transaction clears the value; native-only repaint and animation frames do not.

Errors

Returns ScriptViewError::DisposedView after disposal.

pub fn last_diagnostic( &self, cx: &App, ) -> Result<Option<Diagnostic>, ScriptViewError>

Return structured details for the latest script runtime error.

Non-script host errors only have a string representation and return None here.

Errors

Returns ScriptViewError::DisposedView after disposal.

pub fn take_performance_snapshot( &self, cx: &mut App, ) -> Result<ScriptViewPerformanceSnapshot, ScriptViewError>

Drain execution timings and snapshot retained/virtual metrics.

Errors

Returns ScriptViewError::DisposedView after disposal.

pub fn read_signal( &self, signal: &NativeSignal, cx: &App, ) -> Result<SignalValue, ScriptViewError>

Read one mounted native hot value without invoking Rhai.

Errors

Returns after disposal or when the signal is stale.

pub fn write_signal( &self, signal: &NativeSignal, value: SignalValue, cx: &mut App, ) -> Result<bool, ScriptViewError>

Update one mounted native hot value on the GPUI foreground thread.

This repaints signal-bound properties without running a Rhai component.

Errors

Returns after disposal or for stale/type-incompatible values.

pub fn replace_native_collection( &self, name: &str, collection: NativeCollection, cx: &mut App, ) -> Result<bool, ScriptViewError>

Replace one registered Rust-owned collection on the GPUI foreground thread.

Only components that read this collection are marked dirty. The replacement is immutable and can be prepared away from the Rhai runtime.

Errors

Returns after disposal or when the collection name is unknown.

pub fn register_native_collection( &self, name: &str, collection: NativeCollection, cx: &mut App, ) -> Result<(), ScriptViewError>

Register a new Rust-owned collection on an already mounted view.

The name must not already exist. Registration marks the view root dirty; an active view rerenders on the next foreground cycle, while a suspended view consumes the collection when it resumes.

Errors

Returns after disposal or for an unsafe/duplicate collection name.

pub fn replace_native_text_document( &self, name: &str, document: NativeTextDocument, cx: &mut App, ) -> Result<bool, ScriptViewError>

Replace one registered Host-owned text document revision.

Only components that read this document are invalidated. The immutable text snapshot may be prepared on a background thread before publication.

Errors

Returns after disposal or when the document name is unknown.

pub fn element(&self) -> Result<AnyElement, ScriptViewError>

Return the measured embedding element.

Errors

Returns ScriptViewError::DisposedView after explicit disposal.

pub fn flex_item(&self) -> Result<AnyElement, ScriptViewError>

Return the measured view as a zero-basis, shrinkable host flex item.

Use this as the direct child of a Rust flex row or column. It prevents horizontally scrollable script content from contributing an automatic min-content width that expands the surrounding host layout.

Errors

Returns ScriptViewError::DisposedView after explicit disposal.

pub fn suspend( &self, window: &mut Window, cx: &mut App, ) -> Result<bool, ScriptViewError>

Quiesce this retained view without discarding script or native UI state.

Errors

Returns after disposal or when a suspend hook/effect cleanup fails.

pub fn resume(&self, cx: &mut App) -> Result<bool, ScriptViewError>

Atomically resume a suspended view before returning it to Host layout.

Errors

Returns after disposal or when pending delivery, resume hook, reload, or the first restored render fails. A compensable failure leaves the view suspended; failed compensation disposes and quarantines the view.

pub fn dispose(&self, cx: &mut App) -> Result<(), ScriptViewError>

Dispose this view immediately. The operation is idempotent.

Errors

Returns an entity update error only if GPUI has already released the underlying view unexpectedly.

pub fn focus( &self, window: &mut Window, cx: &mut App, ) -> Result<(), ScriptViewError>

Focus this view’s stable root handle.

Errors

Returns ScriptViewError::DisposedView after disposal.

pub fn accessibility_snapshot( &self, cx: &App, ) -> Result<AccessibilityTree, ScriptViewError>

Snapshot the retained semantic tree and last committed geometry.

Errors

Returns after disposal or for an invalid retained semantic graph.

pub fn automation_snapshot( &self, cx: &App, ) -> Result<AutomationSnapshot, ScriptViewError>

Snapshot the stable language-neutral automation tree.

Errors

Returns after disposal or for an invalid retained semantic graph.

pub fn automate( &self, command: AutomationCommand, window: &mut Window, cx: &mut App, ) -> Result<AutomationResult, ScriptViewError>

Execute one automation command on the GPUI foreground thread.

Dispatch and action commands use the mounted production handlers; deterministic time advance requires an injected controllable clock.

Errors

Returns after disposal, for locator/command failures, or runtime errors.

pub fn reconcile_report( &self, cx: &App, ) -> Result<ReconcileReport, ScriptViewError>

Return the last successfully committed retained diff report.

Errors

Returns after disposal.

pub fn focus_element( &self, reference: &ElementRef, window: &mut Window, cx: &mut App, ) -> Result<(), ScriptViewError>

Focus a mounted retained element without invoking Rhai.

Errors

Returns after disposal, for a stale ref, or when the ref has no active GPUI focus handle.

Trait Implementations

impl Clone for ScriptViewHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.