Skip to main content

RuntimeDriver

Struct RuntimeDriver 

Source
pub struct RuntimeDriver<G, H>
where G: NativeDocumentRuntime, H: NativeHost<Guest = G> + 'static,
{ /* private fields */ }
Expand description

A document runtime backed by one caller supplied native guest and host.

Implementations§

Source§

impl<G, H> RuntimeDriver<G, H>
where G: NativeDocumentRuntime, H: NativeHost<Guest = G> + 'static,

Source

pub fn new_bound( html: Arc<str>, config: DocumentConfig, host: H, ) -> Result<Self, String>

Parse HTML and bind the supplied host and its guest.

Source

pub fn from_document( document: BoundScriptDocument<G, H>, ) -> Result<Self, String>

Wrap an already parsed and bound document.

Source

pub fn document(&self) -> &BoundScriptDocument<G, H>

Borrow the bound document.

Source

pub fn document_mut(&mut self) -> &mut BoundScriptDocument<G, H>

Mutably borrow the bound document.

Source

pub fn into_document(self) -> BoundScriptDocument<G, H>

Consume the driver and return its bound document.

Source

pub fn execute_scripts(&mut self) -> Result<(), String>

Execute the document’s scripts through its bound guest.

Source

pub fn eval(&mut self, source: &str) -> Result<(), String>

Evaluate source through the bound guest.

Source

pub fn eval_named(&mut self, source: &str, name: &str) -> Result<(), String>

Evaluate named source through the bound guest.

Source

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

Evaluate source and return its JSON-compatible result.

Source

pub fn has_pending_jobs(&self) -> bool

Whether the guest reports pending jobs for this document.

Source

pub fn diagnostic_batch( &self, console_after: u64, errors_after: u64, limit: usize, ) -> Result<DiagnosticBatch, String>

Return a bounded batch of diagnostics from the bound guest.

Source

pub fn dispatch_node_event( &mut self, node: NodeId, name: &str, ) -> Result<bool, String>

Dispatch an event to a document node through the bound guest.

Source

pub fn guest(&self) -> Option<&G>

Access the native guest owned by this document.

Source

pub fn guest_mut(&mut self) -> Option<&mut G>

Mutably access the native guest owned by this document.

Source

pub fn with_guest_mut<R>( &mut self, callback: impl FnOnce(&mut G, &mut BaseDocument) -> R, ) -> Result<R, String>

Run a closure with mutable access to the native guest.

Source

pub fn pending_task_count(&self) -> u64

Source

pub fn dispatch_dom_event(&mut self, event: DomEvent) -> Result<(), String>

Source

pub fn handle_pointer_move_to_node( &mut self, event: BlitzPointerEvent, node: NodeId, ) -> Result<(), String>

Source

pub fn handle_ui_event_to_node( &mut self, event: UiEvent, node: NodeId, ) -> Result<(), String>

Source

pub fn set_ipc_handler( &mut self, handler: Box<dyn Fn(String)>, ) -> Result<(), String>

Source

pub fn add_poll_hook(&mut self, hook: DocumentPollHook) -> Result<(), String>

Trait Implementations§

Source§

impl<G, H> Document for RuntimeDriver<G, H>
where G: NativeDocumentRuntime, H: NativeHost<Guest = G> + 'static,

Source§

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

Source§

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

Source§

fn handle_ui_event(&mut self, event: UiEvent)

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

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

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

fn poll_for_settle( &mut self, context: Option<Context<'_>>, run_timers: bool, ) -> bool

Drain immediate work for a host’s settle loop. Read more
Source§

fn prepare_teardown(&mut self)

Revoke child work before ownership is dropped. Completion is separate.
Source§

fn dispose(self: Box<Self>) -> Arc<Teardown> ⓘ

Source§

fn set_page_visible(&mut self, visible: bool)

Source§

fn freeze(&mut self)

Source§

fn finish_restore(&mut self)

Source§

fn resume(&mut self)

Source§

fn id(&self) -> usize

Get the Document’s id

Auto Trait Implementations§

§

impl<G, H> !Freeze for RuntimeDriver<G, H>

§

impl<G, H> !RefUnwindSafe for RuntimeDriver<G, H>

§

impl<G, H> !Send for RuntimeDriver<G, H>

§

impl<G, H> !Sync for RuntimeDriver<G, H>

§

impl<G, H> !UnwindSafe for RuntimeDriver<G, H>

§

impl<G, H> Forget for RuntimeDriver<G, H>

§

impl<G, H> Move for RuntimeDriver<G, H>

§

impl<G, H> Unpin for RuntimeDriver<G, H>

§

impl<G, H> UnsafeUnpin for RuntimeDriver<G, H>

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<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, 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> MaybeBoxed<Box<T>> for T

Source§

fn maybe_boxed(self) -> Box<T>

Convert
Source§

impl<T> MaybeBoxed<T> for T

Source§

fn maybe_boxed(self) -> T

Convert
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, 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.