Struct v8::EscapableHandleScope

pub struct EscapableHandleScope<'s, 'e: 's, C = Context> { /* private fields */ }

A HandleScope which first allocates a handle in the current scope which will be later filled with the escape value.

Implementations

impl<'s, 'e: 's> EscapableHandleScope<'s, 'e>

pub fn new<P: NewEscapableHandleScope<'s, 'e>>(param: &'s mut P) -> P::NewScope

impl<'s, 'e: 's, C> EscapableHandleScope<'s, 'e, C>

pub fn escape<T>(&mut self, value: Local<'_, T>) -> Local<'e, T>where
    for<'l> Local<'l, T>: Into<Local<'l, Data>>,

Pushes the value into the previous scope and returns a handle to it. Cannot be called twice.

Methods from Deref<Target = HandleScope<'s, ()>>

pub fn get_current_context(&self) -> Local<'s, Context>

Returns the context of the currently running JavaScript, or the context on the top of the stack if no JavaScript is running.

pub fn get_entered_or_microtask_context(&self) -> Local<'s, Context>

Returns either the last context entered through V8’s C++ API, or the context of the currently running microtask while processing microtasks. If a context is entered while executing a microtask, that context is returned.

pub fn throw_exception(
    &mut self,
    exception: Local<'_, Value>
) -> Local<'s, Value>

Schedules an exception to be thrown when returning to JavaScript. When an exception has been scheduled it is illegal to invoke any JavaScript operation; the caller must return immediately and only after the exception has been handled does it become legal to invoke JavaScript operations.

This function always returns the undefined value.

pub fn get_isolate_data_from_snapshot_once<T>(
    &mut self,
    index: usize
) -> Result<Local<'s, T>, DataError>where
    T: 'static,
    for<'l> Local<'l, Data>: TryInto<Local<'l, T>, Error = DataError>,

Return data that was previously attached to the isolate snapshot via SnapshotCreator, and removes the reference to it. If called again with same index argument, this function returns DataError::NoData.

The value that was stored in the snapshot must either match or be convertible to type parameter T, otherwise DataError::BadType is returned.

pub fn get_context_data_from_snapshot_once<T>(
    &mut self,
    index: usize
) -> Result<Local<'s, T>, DataError>where
    T: 'static,
    for<'l> Local<'l, Data>: TryInto<Local<'l, T>, Error = DataError>,

Return data that was previously attached to the context snapshot via SnapshotCreator, and removes the reference to it. If called again with same index argument, this function returns DataError::NoData.

The value that was stored in the snapshot must either match or be convertible to type parameter T, otherwise DataError::BadType is returned.

Methods from Deref<Target = Isolate>

pub fn thread_safe_handle(&self) -> IsolateHandle

pub fn terminate_execution(&self) -> bool

See IsolateHandle::terminate_execution

pub fn cancel_terminate_execution(&self) -> bool

See IsolateHandle::cancel_terminate_execution

pub fn is_execution_terminating(&self) -> bool

See IsolateHandle::is_execution_terminating

pub fn get_data(&self, slot: u32) -> *mut c_void

Retrieve embedder-specific data from the isolate. Returns NULL if SetData has never been called for the given slot.

pub fn set_data(&mut self, slot: u32, data: *mut c_void)

Associate embedder-specific data with the isolate. slot has to be between 0 and Isolate::get_number_of_data_slots().

pub fn get_number_of_data_slots(&self) -> u32

Returns the maximum number of available embedder data slots. Valid slots are in the range of 0 <= n < Isolate::get_number_of_data_slots().

pub fn get_slot<T: 'static>(&self) -> Option<&T>

Get a reference to embedder data added with set_slot().

pub fn get_slot_mut<T: 'static>(&mut self) -> Option<&mut T>

Get a mutable reference to embedder data added with set_slot().

pub fn set_slot<T: 'static>(&mut self, value: T) -> bool

Use with Isolate::get_slot and Isolate::get_slot_mut to associate state with an Isolate.

This method gives ownership of value to the Isolate. Exactly one object of each type can be associated with an Isolate. If called more than once with an object of the same type, the earlier version will be dropped and replaced.

Returns true if value was set without replacing an existing value.

The value will be dropped when the isolate is dropped.

pub fn remove_slot<T: 'static>(&mut self) -> Option<T>

Removes the embedder data added with set_slot() and returns it if it exists.

pub unsafe fn enter(&mut self)

Sets this isolate as the entered one for the current thread. Saves the previously entered one (if any), so that it can be restored when exiting. Re-entering an isolate is allowed.

rusty_v8 note: Unlike in the C++ API, the isolate is entered when it is constructed and exited when dropped.

pub unsafe fn exit(&mut self)

Exits this isolate by restoring the previously entered one in the current thread. The isolate may still stay the same, if it was entered more than once.

Requires: self == Isolate::GetCurrent().

rusty_v8 note: Unlike in the C++ API, the isolate is entered when it is constructed and exited when dropped.

pub fn clear_kept_objects(&mut self)

Clears the set of objects held strongly by the heap. This set of objects are originally built when a WeakRef is created or successfully dereferenced.

This is invoked automatically after microtasks are run. See MicrotasksPolicy for when microtasks are run.

This needs to be manually invoked only if the embedder is manually running microtasks via a custom MicrotaskQueue class’s PerformCheckpoint. In that case, it is the embedder’s responsibility to make this call at a time which does not interrupt synchronous ECMAScript code execution.

pub fn low_memory_notification(&mut self)

Optional notification that the system is running low on memory. V8 uses these notifications to attempt to free memory.

pub fn get_heap_statistics(&mut self, s: &mut HeapStatistics)

Get statistics about the heap memory usage.

pub fn set_capture_stack_trace_for_uncaught_exceptions(
    &mut self,
    capture: bool,
    frame_limit: i32
)

Tells V8 to capture current stack trace when uncaught exception occurs and report it to the message listeners. The option is off by default.

pub fn add_message_listener(&mut self, callback: MessageCallback) -> bool

Adds a message listener (errors only).

The same message listener can be added more than once and in that case it will be called more than once for each message.

The exception object will be passed to the callback.

pub fn set_prepare_stack_trace_callback<'s>(
    &mut self,
    callback: impl MapFnTo<extern "C" fn(_: Local<'s, Context>, _: Local<'s, Value>, _: Local<'s, Array>) -> PrepareStackTraceCallbackRet>
)

This specifies the callback called when the stack property of Error is accessed.

PrepareStackTraceCallback is called when the stack property of an error is first accessed. The return value will be used as the stack value. If this callback is registed, the |Error.prepareStackTrace| API will be disabled. |sites| is an array of call sites, specified in https://v8.dev/docs/stack-trace-api

pub fn set_promise_hook(&mut self, hook: PromiseHook)

Set the PromiseHook callback for various promise lifecycle events.

pub fn set_promise_reject_callback(&mut self, callback: PromiseRejectCallback)

Set callback to notify about promise reject with no handler, or revocation of such a previous notification once the handler is added.

pub fn set_wasm_async_resolve_promise_callback(
    &mut self,
    callback: extern "C" fn(_: *mut Isolate, _: Local<'_, Context>, _: Local<'_, PromiseResolver>, _: Local<'_, Value>, _: WasmAsyncSuccess)
)

pub fn set_host_initialize_import_meta_object_callback(
    &mut self,
    callback: HostInitializeImportMetaObjectCallback
)

This specifies the callback called by the upcoming importa.meta language feature to retrieve host-defined meta data for a module.

pub fn set_host_import_module_dynamically_callback(
    &mut self,
    callback: impl HostImportModuleDynamicallyCallback
)

This specifies the callback called by the upcoming dynamic import() language feature to load modules.

pub fn set_host_create_shadow_realm_context_callback(
    &mut self,
    callback: HostCreateShadowRealmContextCallback
)

This specifies the callback called by the upcoming ShadowRealm construction language feature to retrieve host created globals.

pub fn add_near_heap_limit_callback(
    &mut self,
    callback: NearHeapLimitCallback,
    data: *mut c_void
)

Add a callback to invoke in case the heap size is close to the heap limit. If multiple callbacks are added, only the most recently added callback is invoked.

pub fn remove_near_heap_limit_callback(
    &mut self,
    callback: NearHeapLimitCallback,
    heap_limit: usize
)

Remove the given callback and restore the heap limit to the given limit. If the given limit is zero, then it is ignored. If the current heap size is greater than the given limit, then the heap limit is restored to the minimal limit that is possible for the current heap size.

pub fn adjust_amount_of_external_allocated_memory(
    &mut self,
    change_in_bytes: i64
) -> i64

Adjusts the amount of registered external memory. Used to give V8 an indication of the amount of externally allocated memory that is kept alive by JavaScript objects. V8 uses this to decide when to perform global garbage collections. Registering externally allocated memory will trigger global garbage collections more often than it would otherwise in an attempt to garbage collect the JavaScript objects that keep the externally allocated memory alive.

pub fn set_oom_error_handler(&mut self, callback: OomErrorCallback)

pub fn get_microtasks_policy(&self) -> MicrotasksPolicy

Returns the policy controlling how Microtasks are invoked.

pub fn set_microtasks_policy(&mut self, policy: MicrotasksPolicy)

Returns the policy controlling how Microtasks are invoked.

pub fn perform_microtask_checkpoint(&mut self)

Runs the default MicrotaskQueue until it gets empty and perform other microtask checkpoint steps, such as calling ClearKeptObjects. Asserts that the MicrotasksPolicy is not kScoped. Any exceptions thrown by microtask callbacks are swallowed.

pub fn run_microtasks(&mut self)

👎Deprecated: Use Isolate::perform_microtask_checkpoint() instead

An alias for PerformMicrotaskCheckpoint.

pub fn enqueue_microtask(&mut self, microtask: Local<'_, Function>)

Enqueues the callback to the default MicrotaskQueue

pub fn set_allow_atomics_wait(&mut self, allow: bool)

Set whether calling Atomics.wait (a function that may block) is allowed in this isolate. This can also be configured via CreateParams::allow_atomics_wait.

pub fn set_wasm_streaming_callback<F>(&mut self, _: F)where
    F: UnitType + Fn(&mut HandleScope<'_>, Local<'_, Value>, WasmStreaming),

Embedder injection point for WebAssembly.compileStreaming(source). The expectation is that the embedder sets it at most once.

The callback receives the source argument (string, Promise, etc.) and an instance of WasmStreaming. The WasmStreaming instance can outlive the callback and is used to feed data chunks to V8 asynchronously.

pub fn has_pending_background_tasks(&self) -> bool

Returns true if there is ongoing background work within V8 that will eventually post a foreground task, like asynchronous WebAssembly compilation.

pub fn take_heap_snapshot<F>(&mut self, callback: F)where
    F: FnMut(&[u8]) -> bool,

Take a heap snapshot. The callback is invoked one or more times with byte slices containing the snapshot serialized as JSON. It’s the callback’s responsibility to reassemble them into a single document, e.g., by writing them to a file. Note that Chrome DevTools refuses to load snapshots without a .heapsnapshot suffix.

pub fn set_default_context(&mut self, context: Local<'_, Context>)

Set the default context to be included in the snapshot blob. The snapshot will not contain the global proxy, and we expect one or a global object template to create one, to be provided upon deserialization.

Panics

Panics if the isolate was not created using Isolate::snapshot_creator

pub fn add_context(&mut self, context: Local<'_, Context>) -> usize

Add additional context to be included in the snapshot blob. The snapshot will include the global proxy.

Returns the index of the context in the snapshot blob.

Panics

Panics if the isolate was not created using Isolate::snapshot_creator

pub fn add_isolate_data<T>(&mut self, data: Local<'_, T>) -> usizewhere
    for<'l> Local<'l, T>: Into<Local<'l, Data>>,

Attach arbitrary v8::Data to the isolate snapshot, which can be retrieved via HandleScope::get_context_data_from_snapshot_once() after deserialization. This data does not survive when a new snapshot is created from an existing snapshot.

Panics

Panics if the isolate was not created using Isolate::snapshot_creator

pub fn add_context_data<T>(
    &mut self,
    context: Local<'_, Context>,
    data: Local<'_, T>
) -> usizewhere
    for<'l> Local<'l, T>: Into<Local<'l, Data>>,

Attach arbitrary v8::Data to the context snapshot, which can be retrieved via HandleScope::get_context_data_from_snapshot_once() after deserialization. This data does not survive when a new snapshot is created from an existing snapshot.

Panics

Panics if the isolate was not created using Isolate::snapshot_creator

Trait Implementations

impl<'s, 'p, 'e> AsMut<EscapableHandleScope<'p, 'e, ()>> for ContextScope<'s, EscapableHandleScope<'p, 'e>>

fn as_mut(&mut self) -> &mut EscapableHandleScope<'p, 'e, ()>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'s, 'p, 'e, C> AsMut<EscapableHandleScope<'p, 'e, ()>> for TryCatch<'s, EscapableHandleScope<'p, 'e, C>>

fn as_mut(&mut self) -> &mut EscapableHandleScope<'p, 'e, ()>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'s, 'p, 'e> AsMut<EscapableHandleScope<'p, 'e, Context>> for ContextScope<'s, EscapableHandleScope<'p, 'e>>

fn as_mut(&mut self) -> &mut EscapableHandleScope<'p, 'e>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'s, 'p, 'e> AsMut<EscapableHandleScope<'p, 'e, Context>> for TryCatch<'s, EscapableHandleScope<'p, 'e>>

fn as_mut(&mut self) -> &mut EscapableHandleScope<'p, 'e>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'s, 'e, C> AsMut<EscapableHandleScope<'s, 'e, ()>> for EscapableHandleScope<'s, 'e, C>

fn as_mut(&mut self) -> &mut EscapableHandleScope<'s, 'e, ()>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'s, 'e> AsMut<EscapableHandleScope<'s, 'e, Context>> for EscapableHandleScope<'s, 'e>

fn as_mut(&mut self) -> &mut EscapableHandleScope<'s, 'e>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'s, 'e, C> AsMut<HandleScope<'s, ()>> for EscapableHandleScope<'s, 'e, C>

fn as_mut(&mut self) -> &mut HandleScope<'s, ()>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'s, 'e> AsMut<HandleScope<'s, Context>> for EscapableHandleScope<'s, 'e>

fn as_mut(&mut self) -> &mut HandleScope<'s>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'s, 'e, C> AsMut<Isolate> for EscapableHandleScope<'s, 'e, C>

fn as_mut(&mut self) -> &mut Isolate

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'s, 'p, 'e> AsRef<EscapableHandleScope<'p, 'e, ()>> for ContextScope<'s, EscapableHandleScope<'p, 'e>>

fn as_ref(&self) -> &EscapableHandleScope<'p, 'e, ()>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'s, 'p, 'e, C> AsRef<EscapableHandleScope<'p, 'e, ()>> for TryCatch<'s, EscapableHandleScope<'p, 'e, C>>

fn as_ref(&self) -> &EscapableHandleScope<'p, 'e, ()>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'s, 'p, 'e> AsRef<EscapableHandleScope<'p, 'e, Context>> for ContextScope<'s, EscapableHandleScope<'p, 'e>>

fn as_ref(&self) -> &EscapableHandleScope<'p, 'e>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'s, 'p, 'e> AsRef<EscapableHandleScope<'p, 'e, Context>> for TryCatch<'s, EscapableHandleScope<'p, 'e>>

fn as_ref(&self) -> &EscapableHandleScope<'p, 'e>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'s, 'e, C> AsRef<EscapableHandleScope<'s, 'e, ()>> for EscapableHandleScope<'s, 'e, C>

fn as_ref(&self) -> &EscapableHandleScope<'s, 'e, ()>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'s, 'e> AsRef<EscapableHandleScope<'s, 'e, Context>> for EscapableHandleScope<'s, 'e>

fn as_ref(&self) -> &EscapableHandleScope<'s, 'e>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'s, 'e, C> AsRef<HandleScope<'s, ()>> for EscapableHandleScope<'s, 'e, C>

fn as_ref(&self) -> &HandleScope<'s, ()>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'s, 'e> AsRef<HandleScope<'s, Context>> for EscapableHandleScope<'s, 'e>

fn as_ref(&self) -> &HandleScope<'s>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'s, 'e, C> AsRef<Isolate> for EscapableHandleScope<'s, 'e, C>

fn as_ref(&self) -> &Isolate

Converts this type into a shared reference of the (usually inferred) input type.

impl<'s, 'e: 's, C: Debug> Debug for EscapableHandleScope<'s, 'e, C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'s, 'e> Deref for EscapableHandleScope<'s, 'e, ()>

type Target = HandleScope<'s, ()>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'s, 'e> Deref for EscapableHandleScope<'s, 'e>

type Target = HandleScope<'s, Context>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'s, 'e> DerefMut for EscapableHandleScope<'s, 'e, ()>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'s, 'e> DerefMut for EscapableHandleScope<'s, 'e>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'s, 'e, C> Drop for EscapableHandleScope<'s, 'e, C>

fn drop(&mut self)

Executes the destructor for this type.