ViewJSContextGuard

Struct ViewJSContextGuard 

Source
pub struct ViewJSContextGuard<'a> { /* private fields */ }
Expand description

An RAII implementation of a “scoped lock” of a pixel buffer for Javascript Context of View. When this structure is dropped (falls out of scope), the lock will be unlocked.

This struct is created by View::lock_js_context.

This can be used as Deref to access the underlying JSContext.

Methods from Deref<Target = JSContext>§

Source

pub fn global_object(&self) -> JSObject<'_>

Get the global object for this context.

Source

pub fn global_context(&self) -> JSContext

Get the global context for this context.

Source

pub fn name(&self) -> Option<JSString>

Get the name of this context.

A JSGlobalContext’s name is exposed when inspecting the context to make it easier to identify the context you would like to inspect.

The context may not have a name, in which case this method will return None.

Source

pub fn is_inspectable(&self) -> bool

Gets whether the context is inspectable in Web Inspector.

Source

pub fn evaluate_script(&self, script: &str) -> Result<JSValue<'_>, JSValue<'_>>

Evaluate a JavaScript script in this context.

If an exception is thrown during evaluation, it will be returned as an Err value, otherwise the result of the script evaluation will be returned as an Ok value.

Source

pub fn check_script_syntax(&self, script: &str) -> Result<bool, JSValue<'_>>

Checks for syntax errors in a string of JavaScript.

true if the script is syntactically correct, otherwise false.

Source

pub fn garbage_collect(&self)

Performs a JavaScript garbage collection.

JavaScript values that are on the machine stack, in a register, protected by JSValueProtect, set as the global object of an execution context, or reachable from any such value will not be collected.

During JavaScript execution, you are not required to call this function; the JavaScript engine will garbage collect as needed. JavaScript values created within a context group are automatically destroyed when the last reference to the context group is released.

Trait Implementations§

Source§

impl Drop for ViewJSContextGuard<'_>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Deref for ViewJSContextGuard<'_>

Source§

type Target = JSContext

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.

Auto Trait Implementations§

§

impl<'a> Freeze for ViewJSContextGuard<'a>

§

impl<'a> RefUnwindSafe for ViewJSContextGuard<'a>

§

impl<'a> !Send for ViewJSContextGuard<'a>

§

impl<'a> !Sync for ViewJSContextGuard<'a>

§

impl<'a> Unpin for ViewJSContextGuard<'a>

§

impl<'a> UnwindSafe for ViewJSContextGuard<'a>

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> 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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.