Skip to main content

ScriptView

Struct ScriptView 

Source
pub struct ScriptView { /* private fields */ }
Expand description

A script view: its ui/ tree and the Host’s configuration.

script_view! reads the files of the crate’s ui/ directory in a debug build and the copy gpui-rhai-build embedded in a release build, so a Host writes one mount. ScriptView::files, ScriptView::embedded and ScriptView::sources choose explicitly.

Implementations§

Source§

impl ScriptView

Source

pub fn files(path: impl Into<PathBuf>) -> Self

Read the ui/ tree from disk: path is the entry script, or a ui directory whose app.toml names it. Development (hot reload) is on in a debug build with the dev-reload feature.

Source

pub fn embedded(ui: &'static EmbeddedUi) -> Self

Read the tree gpui-rhai-build compiled into the binary.

Source

pub fn sources( entry: ModuleId, scripts: EmbeddedScriptSource, theme_source: impl Into<String>, ) -> Self

Run sources the Host supplies in memory: the entry module, the modules it may import and the primary theme. Self::theme_sources, Self::locale_sources, Self::asset_sources, Self::component_styles, Self::profile_source and Self::manifest add the other parts of a ui/ directory.

Source

pub fn ui_override_env(self, name: impl Into<String>) -> Self

Read the ui/ tree from the files at the path in environment variable name when it is set, whatever the source. script_view! honors GPUI_RHAI_UI in a debug build; a release build honors a variable only when the Host names one here, since swapping the scripts of a signed application is a way to inject code into it.

Source

pub const fn accept_file_drops(self, accept: bool) -> Self

Let a DropZone that lists the os.files payload type take files and folders the operating system drags in. Off by default. The script’s drop event carries an opaque handle for each, never its path; the Host turns one back into the path with crate::DroppedFiles::path on crate::UiRuntimeState::dropped_files.

Source

pub fn profile_source(self, source: impl Into<String>) -> Self

Install an application profile (profile() -> map) whose audit rules ScriptViewHandle::composition_audit applies. In-memory sources only.

Source

pub fn locale_sources( self, locales: impl IntoIterator<Item = (String, String)>, ) -> Self

The locales (name, source) of in-memory sources.

Source

pub fn theme_sources( self, themes: impl IntoIterator<Item = (String, String)>, ) -> Self

The additional themes (name, source) of in-memory sources.

Source

pub fn component_styles(self, source: impl Into<String>) -> Self

Install one application-wide typed component stylesheet. In-memory sources only.

Source

pub fn manifest(self, manifest: AppManifest) -> Self

The application manifest of in-memory sources.

Source

pub fn asset_sources( self, assets: impl IntoIterator<Item = (String, AssetData)>, ) -> Self

The app asset namespace of in-memory sources.

Source

pub fn token_base(self, source: impl Into<String>) -> Self

Use this token base source instead of the tree’s tokens.rhai.

Source

pub const fn development(self, enabled: bool) -> Self

Reload changed sources while the view runs (with the dev-reload feature). Files only.

Source

pub const fn motion_preference(self, preference: MotionPreference) -> Self

Source

pub const fn motion_quality(self, quality: MotionQuality) -> Self

Source

pub fn extension(self, extension: impl ScriptViewExtension + 'static) -> Self

Source

pub fn key_binding(self, binding: KeyBindingSpec) -> Self

Source

pub const fn viewport_breakpoints( self, breakpoints: ViewportBreakpoints, ) -> Self

Source

pub fn calendar_clock(self, clock: CalendarClock) -> Self

Source

pub fn wall_clock(self, clock: WallClock) -> Self

Inject a presentation wall clock, independent from animation and calendar clocks.

Source

pub fn runtime_clock(self, clock: RuntimeClock) -> Self

Source

pub fn font_source(self, font: FontSource) -> Self

Source

pub fn font_sources(self, fonts: impl IntoIterator<Item = FontSource>) -> Self

Source

pub fn theme_token_overrides(self, overrides: ThemeTokenOverrides) -> Self

Apply host-owned user preferences to every theme loaded by this view.

Source

pub fn operation_limit(self, limit: u64) -> Self

Raise or lower the per-execution script operation budget for this view’s scripts. Omitting this builder keeps the runtime’s built-in 1,000,000-operation budget; hosts that run known one-shot cacheable script phases may raise it. The limit is applied to every engine instantiated for this view, including hot-reload candidates and additional windows. Zero normalizes to one. This quota does not promise a frame time or preempt native Rust work. Trusted extensions run after builder policy.

Source

pub fn expression_depth_limits(self, global: usize, functions: usize) -> Self

Set trusted parser depth limits; default global=64/function=64. Zero normalizes to one. Builder policy is applied before trusted extensions, which may override it; the same ordering applies to children.

Source

pub fn prepare(self) -> Result<PreparedScriptView, ScriptViewError>

Read, compile, initialize, and render the app before opening GPUI.

§Errors

Returns ScriptViewError for source I/O, compilation, lifecycle, or initial rendering failures, or an in-memory source option used on another source.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more