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
impl ScriptView
Sourcepub fn files(path: impl Into<PathBuf>) -> Self
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.
Sourcepub fn embedded(ui: &'static EmbeddedUi) -> Self
pub fn embedded(ui: &'static EmbeddedUi) -> Self
Read the tree gpui-rhai-build compiled into the binary.
Sourcepub fn sources(
entry: ModuleId,
scripts: EmbeddedScriptSource,
theme_source: impl Into<String>,
) -> Self
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.
Sourcepub fn ui_override_env(self, name: impl Into<String>) -> Self
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.
Sourcepub const fn accept_file_drops(self, accept: bool) -> Self
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.
Sourcepub fn profile_source(self, source: impl Into<String>) -> Self
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.
Sourcepub fn locale_sources(
self,
locales: impl IntoIterator<Item = (String, String)>,
) -> Self
pub fn locale_sources( self, locales: impl IntoIterator<Item = (String, String)>, ) -> Self
The locales (name, source) of in-memory sources.
Sourcepub fn theme_sources(
self,
themes: impl IntoIterator<Item = (String, String)>,
) -> Self
pub fn theme_sources( self, themes: impl IntoIterator<Item = (String, String)>, ) -> Self
The additional themes (name, source) of in-memory sources.
Sourcepub fn component_styles(self, source: impl Into<String>) -> Self
pub fn component_styles(self, source: impl Into<String>) -> Self
Install one application-wide typed component stylesheet. In-memory sources only.
Sourcepub fn manifest(self, manifest: AppManifest) -> Self
pub fn manifest(self, manifest: AppManifest) -> Self
The application manifest of in-memory sources.
Sourcepub fn asset_sources(
self,
assets: impl IntoIterator<Item = (String, AssetData)>,
) -> Self
pub fn asset_sources( self, assets: impl IntoIterator<Item = (String, AssetData)>, ) -> Self
The app asset namespace of in-memory sources.
Sourcepub fn token_base(self, source: impl Into<String>) -> Self
pub fn token_base(self, source: impl Into<String>) -> Self
Use this token base source instead of the tree’s tokens.rhai.
Sourcepub const fn development(self, enabled: bool) -> Self
pub const fn development(self, enabled: bool) -> Self
Reload changed sources while the view runs (with the dev-reload
feature). Files only.
pub const fn motion_preference(self, preference: MotionPreference) -> Self
pub const fn motion_quality(self, quality: MotionQuality) -> Self
pub fn extension(self, extension: impl ScriptViewExtension + 'static) -> Self
pub fn key_binding(self, binding: KeyBindingSpec) -> Self
pub const fn viewport_breakpoints( self, breakpoints: ViewportBreakpoints, ) -> Self
pub fn calendar_clock(self, clock: CalendarClock) -> Self
Sourcepub fn wall_clock(self, clock: WallClock) -> Self
pub fn wall_clock(self, clock: WallClock) -> Self
Inject a presentation wall clock, independent from animation and calendar clocks.
pub fn runtime_clock(self, clock: RuntimeClock) -> Self
pub fn font_source(self, font: FontSource) -> Self
pub fn font_sources(self, fonts: impl IntoIterator<Item = FontSource>) -> Self
Sourcepub fn theme_token_overrides(self, overrides: ThemeTokenOverrides) -> Self
pub fn theme_token_overrides(self, overrides: ThemeTokenOverrides) -> Self
Apply host-owned user preferences to every theme loaded by this view.
Sourcepub fn operation_limit(self, limit: u64) -> Self
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.
Sourcepub fn expression_depth_limits(self, global: usize, functions: usize) -> Self
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.
Sourcepub fn prepare(self) -> Result<PreparedScriptView, ScriptViewError>
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§
impl !RefUnwindSafe for ScriptView
impl !Send for ScriptView
impl !Sync for ScriptView
impl !UnwindSafe for ScriptView
impl Forget for ScriptView
impl Freeze for ScriptView
impl Move for ScriptView
impl Unpin for ScriptView
impl UnsafeUnpin for ScriptView
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.impl<T> ErasedDestructor for Twhere
T: 'static,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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