V8 API Reference, 7.2.502.16 (for Deno 0.2.4)
|
#include <v8.h>
Public Member Functions | |
template<class S > | |
V8_INLINE | Local (Local< S > that) |
V8_INLINE bool | IsEmpty () const |
V8_INLINE void | Clear () |
V8_INLINE T * | operator-> () const |
V8_INLINE T * | operator* () const |
template<class S > | |
V8_INLINE bool | operator== (const Local< S > &that) const |
template<class S > | |
V8_INLINE bool | operator== (const PersistentBase< S > &that) const |
template<class S > | |
V8_INLINE bool | operator!= (const Local< S > &that) const |
template<class S > | |
V8_INLINE bool | operator!= (const Persistent< S > &that) const |
template<class S > | |
V8_INLINE Local< S > | As () const |
Static Public Member Functions | |
template<class S > | |
static V8_INLINE Local< T > | Cast (Local< S > that) |
static V8_INLINE Local< T > | New (Isolate *isolate, Local< T > that) |
static V8_INLINE Local< T > | New (Isolate *isolate, const PersistentBase< T > &that) |
Friends | |
class | Utils |
template<class F > | |
class | Eternal |
template<class F > | |
class | PersistentBase |
template<class F , class M > | |
class | Persistent |
template<class F > | |
class | Local |
template<class F > | |
class | MaybeLocal |
template<class F > | |
class | FunctionCallbackInfo |
template<class F > | |
class | PropertyCallbackInfo |
class | String |
class | Object |
class | Context |
class | Isolate |
class | Private |
template<class F > | |
class | internal::CustomArguments |
class | HandleScope |
class | EscapableHandleScope |
template<class F1 , class F2 , class F3 > | |
class | PersistentValueMapBase |
template<class F1 , class F2 > | |
class | PersistentValueVector |
template<class F > | |
class | ReturnValue |
Local< Primitive > | Undefined (Isolate *isolate) |
Local< Primitive > | Null (Isolate *isolate) |
Local< Boolean > | True (Isolate *isolate) |
Local< Boolean > | False (Isolate *isolate) |
An object reference managed by the v8 garbage collector.
All objects returned from v8 have to be tracked by the garbage collector so that it knows that the objects are still alive. Also, because the garbage collector may move objects, it is unsafe to point directly to an object. Instead, all objects are stored in handles which are known by the garbage collector and updated whenever an object moves. Handles should always be passed by value (except in cases like out-parameters) and they should never be allocated on the heap.
There are two types of handles: local and persistent handles.
Local handles are light-weight and transient and typically used in local operations. They are managed by HandleScopes. That means that a HandleScope must exist on the stack when they are created and that they are only valid inside of the HandleScope active during their creation. For passing a local handle to an outer HandleScope, an EscapableHandleScope and its Escape() method must be used.
Persistent handles can be used when storing objects across several independent operations and have to be explicitly deallocated when they're no longer used.
It is safe to extract the object stored in the handle by dereferencing the handle (for instance, to extract the Object* from a Local<Object>); the value will still be governed by a handle behind the scenes and the same rules apply to these values as to their handles.
Calling this is equivalent to Local<S>::Cast(). In particular, this is only valid if the handle actually refers to a value of the target type.
|
inline |