V8 API Reference, 7.2.502.16 (for Deno 0.2.4)
v8::MaybeLocal< T > Class Template Reference

#include <v8.h>

Public Member Functions

template<class S >
V8_INLINE MaybeLocal (Local< S > that)
 
V8_INLINE bool IsEmpty () const
 
template<class S >
V8_WARN_UNUSED_RESULT V8_INLINE bool ToLocal (Local< S > *out) const
 
V8_INLINE Local< TToLocalChecked ()
 
template<class S >
V8_INLINE Local< S > FromMaybe (Local< S > default_value) const
 

Detailed Description

template<class T>
class v8::MaybeLocal< T >

A MaybeLocal<> is a wrapper around Local<> that enforces a check whether the Local<> is empty before it can be used.

If an API method returns a MaybeLocal<>, the API method can potentially fail either because an exception is thrown, or because an exception is pending, e.g. because a previous API call threw an exception that hasn't been caught yet, or because a TerminateExecution exception was thrown. In that case, an empty MaybeLocal is returned.

Definition at line 87 of file v8.h.

Member Function Documentation

◆ FromMaybe()

template<class T>
template<class S >
V8_INLINE Local<S> v8::MaybeLocal< T >::FromMaybe ( Local< S >  default_value) const
inline

Converts this MaybeLocal<> to a Local<>, using a default value if this MaybeLocal<> is empty.

Definition at line 363 of file v8.h.

◆ ToLocal()

template<class T>
template<class S >
V8_WARN_UNUSED_RESULT V8_INLINE bool v8::MaybeLocal< T >::ToLocal ( Local< S > *  out) const
inline

Converts this MaybeLocal<> to a Local<>. If this MaybeLocal<> is empty, |false| is returned and |out| is left untouched.

Definition at line 347 of file v8.h.

◆ ToLocalChecked()

template<class T >
Local< T > v8::MaybeLocal< T >::ToLocalChecked ( )

Converts this MaybeLocal<> to a Local<>. If this MaybeLocal<> is empty, V8 will crash the process.

Definition at line 9402 of file v8.h.


The documentation for this class was generated from the following file: