Struct v8::TryCatch

pub struct TryCatch<'s, P> { /* private fields */ }

An external exception handler.

Implementations

impl<'s, P: NewTryCatch<'s>> TryCatch<'s, P>

pub fn new(param: &'s mut P) -> P::NewScope

impl<'s, P> TryCatch<'s, P>

pub fn has_caught(&self) -> bool

Returns true if an exception has been caught by this try/catch block.

pub fn can_continue(&self) -> bool

For certain types of exceptions, it makes no sense to continue execution.

If CanContinue returns false, the correct action is to perform any C++ cleanup needed and then return. If CanContinue returns false and HasTerminated returns true, it is possible to call CancelTerminateExecution in order to continue calling into the engine.

pub fn has_terminated(&self) -> bool

Returns true if an exception has been caught due to script execution being terminated.

There is no JavaScript representation of an execution termination exception. Such exceptions are thrown when the TerminateExecution methods are called to terminate a long-running script.

If such an exception has been thrown, HasTerminated will return true, indicating that it is possible to call CancelTerminateExecution in order to continue calling into the engine.

pub fn is_verbose(&self) -> bool

Returns true if verbosity is enabled.

pub fn set_verbose(&mut self, value: bool)

Set verbosity of the external exception handler.

By default, exceptions that are caught by an external exception handler are not reported. Call SetVerbose with true on an external exception handler to have exceptions caught by the handler reported as if they were not caught.

pub fn set_capture_message(&mut self, value: bool)

Set whether or not this TryCatch should capture a Message object which holds source information about where the exception occurred. True by default.

pub fn reset(&mut self)

Clears any exceptions that may have been caught by this try/catch block. After this method has been called, HasCaught() will return false. Cancels the scheduled exception if it is caught and ReThrow() is not called before.

It is not necessary to clear a try/catch block before using it again; if another exception is thrown the previously caught exception will just be overwritten. However, it is often a good idea since it makes it easier to determine which operation threw a given exception.

impl<'s, 'p: 's, P> TryCatch<'s, P>

where Self: AsMut<HandleScope<'p, ()>>,

pub fn exception(&mut self) -> Option<Local<'p, Value>>

Returns the exception caught by this try/catch block. If no exception has been caught an empty handle is returned.

Note: v8.h states that “the returned handle is valid until this TryCatch block has been destroyed”. This is incorrect; the return value lives no longer and no shorter than the active HandleScope at the time this method is called. An issue has been opened about this in the V8 bug tracker: https://bugs.chromium.org/p/v8/issues/detail?id=10537.

pub fn message(&mut self) -> Option<Local<'p, Message>>

Returns the message associated with this exception. If there is no message associated an empty handle is returned.

Note: the remark about the lifetime for the exception() return value applies here too.

pub fn rethrow(&mut self) -> Option<Local<'_, Value>>

Throws the exception caught by this TryCatch in a way that avoids it being caught again by this same TryCatch. As with ThrowException it is illegal to execute any JavaScript operations after calling ReThrow; the caller must return immediately to where the exception is caught.

This function returns the undefined value when successful, or None if no exception was caught and therefore there was nothing to rethrow.

impl<'s, 'p: 's, P> TryCatch<'s, P>

where Self: AsMut<HandleScope<'p>>,

pub fn stack_trace(&mut self) -> Option<Local<'p, Value>>

Returns the .stack property of the thrown object. If no .stack property is present an empty handle is returned.

Methods from Deref<Target = EscapableHandleScope<'p, 'e, ()>>

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> as TryInto<Local<'l, T>>>::Error: ToDataError, for<'l> Local<'l, Data>: TryInto<Local<'l, T>>,

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> as TryInto<Local<'l, T>>>::Error: ToDataError, for<'l> Local<'l, Data>: TryInto<Local<'l, T>>,

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.

pub fn set_promise_hooks( &mut self, init_hook: Option<Local<'_, Function>>, before_hook: Option<Local<'_, Function>>, after_hook: Option<Local<'_, Function>>, resolve_hook: Option<Local<'_, Function>> )

pub fn set_continuation_preserved_embedder_data( &mut self, data: Local<'_, Value> )

pub fn get_continuation_preserved_embedder_data(&mut self) -> Local<'s, Value>

Trait Implementations

impl<'s, 'p, 'e> AsMut<EscapableHandleScope<'p, 'e>> 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, '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<HandleScope<'p>> for TryCatch<'s, EscapableHandleScope<'p, 'e>>

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

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

impl<'s, 'p> AsMut<HandleScope<'p>> for TryCatch<'s, HandleScope<'p>>

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

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

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

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

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

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

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

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

impl<'s, P> AsMut<Isolate> for TryCatch<'s, P>

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

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

impl<'s, 'p, P> AsMut<TryCatch<'p, P>> for AllowJavascriptExecutionScope<'s, TryCatch<'p, P>>

fn as_mut(&mut self) -> &mut TryCatch<'p, P>

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

impl<'s, 'p, P> AsMut<TryCatch<'p, P>> for DisallowJavascriptExecutionScope<'s, TryCatch<'p, P>>

fn as_mut(&mut self) -> &mut TryCatch<'p, P>

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

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

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

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

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

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

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

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

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

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

impl<'s, 'p> AsMut<TryCatch<'s, HandleScope<'p>>> for TryCatch<'s, HandleScope<'p>>

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

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

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

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

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

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

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

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

impl<'s, 'p, 'e> AsRef<EscapableHandleScope<'p, 'e>> 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, '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<HandleScope<'p>> for TryCatch<'s, EscapableHandleScope<'p, 'e>>

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

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

impl<'s, 'p> AsRef<HandleScope<'p>> for TryCatch<'s, HandleScope<'p>>

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

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

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

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

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

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

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

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

impl<'s, P> AsRef<Isolate> for TryCatch<'s, P>

fn as_ref(&self) -> &Isolate

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

impl<'s, 'p, P> AsRef<TryCatch<'p, P>> for AllowJavascriptExecutionScope<'s, TryCatch<'p, P>>

fn as_ref(&self) -> &TryCatch<'p, P>

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

impl<'s, 'p, P> AsRef<TryCatch<'p, P>> for DisallowJavascriptExecutionScope<'s, TryCatch<'p, P>>

fn as_ref(&self) -> &TryCatch<'p, P>

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

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

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

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

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

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

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

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

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

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

impl<'s, 'p> AsRef<TryCatch<'s, HandleScope<'p>>> for TryCatch<'s, HandleScope<'p>>

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

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

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

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

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

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

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

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

impl<'s, P: Debug> Debug for TryCatch<'s, P>

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

Formats the value using the given formatter.

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

type Target = EscapableHandleScope<'p, 'e>

The resulting type after dereferencing.

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

Dereferences the value.

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

type Target = EscapableHandleScope<'p, 'e, ()>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'s, 'p> Deref for TryCatch<'s, HandleScope<'p>>

type Target = HandleScope<'p>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'s, 'p> Deref for TryCatch<'s, HandleScope<'p, ()>>

type Target = HandleScope<'p, ()>

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Mutably dereferences the value.

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

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

Mutably dereferences the value.

impl<'s, 'p> DerefMut for TryCatch<'s, HandleScope<'p>>

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

Mutably dereferences the value.

impl<'s, 'p> DerefMut for TryCatch<'s, HandleScope<'p, ()>>

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

Mutably dereferences the value.

impl<'s, P> Drop for TryCatch<'s, P>

fn drop(&mut self)

Executes the destructor for this type.