Struct ScriptDocument 

pub struct ScriptDocument { /* private fields */ }

A Document which executes the JavaScript contained in the document’s <script> tags, exposing DOM APIs backed by blitz-dom to the scripts.

Construct with ScriptDocument::from_html, then call execute_scripts (this also happens automatically on the first poll). UI events pushed via handle_ui_event are dispatched to JavaScript event listeners before Blitz’s default actions run.

Implementations

impl ScriptDocument

pub fn from_html(html: &str, config: DocumentConfig) -> Self

Parse HTML into a ScriptDocument.

Note: this does not execute any scripts yet. Call execute_scripts to do so (or rely on the first poll doing it automatically).

pub fn with_fetcher(self, fetcher: impl ScriptFetcher) -> Self

Override the ScriptFetcher used to load external (src="...") scripts. The default fetcher supports file: and data: URLs.

pub fn set_ipc_handler(&mut self, handler: impl Fn(String) + 'static)

Install the host callback invoked by window.ipc.postMessage(body).

The callback may forward work to another thread, but JavaScript and DOM state remain on the document’s owning thread. Replacing the callback is supported before script startup.

pub fn set_poll_hook( &mut self, hook: impl for<'a> FnMut(&mut ScriptDocument, Option<&TaskContext<'a>>) -> bool + 'static, )

Install work that an embedder needs to run on the document thread during polling.

The hook runs after document scripts and due timers. Returning true requests a redraw.

pub fn add_poll_hook( &mut self, hook: impl for<'a> FnMut(&mut ScriptDocument, Option<&TaskContext<'a>>) -> bool + 'static, )

Append document-thread work without discarding an embedder’s existing poll lifecycle.

pub fn execute_scripts(&mut self)

Execute the document’s <script> elements in document order, then fire the DOMContentLoaded and load events.

Does nothing if scripts have already been executed.

pub fn external_script_urls(&self) -> Vec<Url>

The resolved URLs of the document’s external (<script src="...">) scripts, in document order.

The ScriptFetcher API is synchronous, so embedders with asynchronous networking can use this to prefetch script sources before calling execute_scripts, and then serve them from memory via a custom fetcher (see with_fetcher).

pub fn eval(&mut self, code: &str)

Evaluate arbitrary JavaScript code in the document’s script context

pub fn eval_json(&mut self, code: &str) -> Result<Value, String>

Evaluate JavaScript and convert its result to JSON.

Embedders use this for APIs that return an evaluation result, such as Tauri’s eval_script_with_callback. JavaScript exceptions are recorded in the runtime diagnostics and returned as an error.

pub fn current_url(&self) -> Option<&Url>

Current document URL for automation and diagnostics.

pub fn page_source(&self) -> String

Serialize the current document tree as HTML.

pub fn dispatch_dom_event(&mut self, event: DomEvent)

Dispatch a synthetic DOM event (e.g. a click created with Node::synthetic_click_event) through the document’s event driver. The event is exposed to JavaScript event listeners, and Blitz’s default actions run unless prevented.

Trait Implementations

impl Document for ScriptDocument

fn inner(&self) -> DocGuard<'_>

fn inner_mut(&mut self) -> DocGuardMut<'_>

fn handle_ui_event(&mut self, event: UiEvent)

Update the Document in response to a UiEvent (click, keypress, etc)

fn poll(&mut self, task_context: Option<TaskContext<'_>>) -> bool

Poll any pending async operations, and flush changes to the underlying BaseDocument

fn id(&self) -> usize

Get the Document’s id