v8  7.8.279 (node 12.19.1)
V8 is Google's open source JavaScript engine
Public Member Functions | Static Public Member Functions | Friends
Persistent< T, M > Class Template Reference

#include <v8.h>

Inheritance diagram for Persistent< T, M >:
Inheritance graph
[legend]
Collaboration diagram for Persistent< T, M >:
Collaboration graph
[legend]

Public Member Functions

V8_INLINE Persistent ()
 
template<class S >
V8_INLINE Persistent (Isolate *isolate, Local< S > that)
 
template<class S , class M2 >
V8_INLINE Persistent (Isolate *isolate, const Persistent< S, M2 > &that)
 
V8_INLINE Persistent (const Persistent &that)
 
template<class S , class M2 >
V8_INLINE Persistent (const Persistent< S, M2 > &that)
 
V8_INLINE Persistent & operator= (const Persistent &that)
 
template<class S , class M2 >
V8_INLINE Persistent & operator= (const Persistent< S, M2 > &that)
 
V8_INLINE ~Persistent ()
 
template<class S >
V8_INLINE Persistent< S > & As () const
 
template<class S , class M2 >
void Copy (const Persistent< S, M2 > &that)
 
- Public Member Functions inherited from PersistentBase< T >
V8_INLINE void Reset ()
 
template<class S >
V8_INLINE void Reset (Isolate *isolate, const Local< S > &other)
 
template<class S >
V8_INLINE void Reset (Isolate *isolate, const PersistentBase< S > &other)
 
V8_INLINE bool IsEmpty () const
 
V8_INLINE void Empty ()
 
V8_INLINE Local< T > Get (Isolate *isolate) 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 PersistentBase< S > &that) const
 
template<class S >
V8_INLINE bool operator!= (const Local< S > &that) const
 
template<typename P >
V8_INLINE void SetWeak (P *parameter, typename WeakCallbackInfo< P >::Callback callback, WeakCallbackType type)
 
V8_INLINE void SetWeak ()
 
template<typename P >
V8_INLINE P * ClearWeak ()
 
V8_INLINE void ClearWeak ()
 
V8_INLINE void AnnotateStrongRetainer (const char *label)
 
V8_INLINE bool IsWeak () const
 
V8_INLINE void SetWrapperClassId (uint16_t class_id)
 
V8_INLINE uint16_t WrapperClassId () const
 
 PersistentBase (const PersistentBase &other)=delete
 
void operator= (const PersistentBase &)=delete
 
template<class S >
void Reset (Isolate *isolate, const Local< S > &other)
 
template<class S >
void Reset (Isolate *isolate, const PersistentBase< S > &other)
 

Static Public Member Functions

template<class S >
static V8_INLINE Persistent< T > & Cast (const Persistent< S > &that)
 

Friends

class Isolate
 
class Utils
 
template<class F >
class Local
 
template<class F1 , class F2 >
class Persistent
 
template<class F >
class ReturnValue
 

Detailed Description

template<class T, class M>
class v8::Persistent< T, M >

A PersistentBase which allows copy and assignment.

Copy, assignment and destructor behavior is controlled by the traits class M.

Note: Persistent class hierarchy is subject to future changes.

Definition at line 634 of file v8.h.

Constructor & Destructor Documentation

◆ Persistent() [1/5]

V8_INLINE Persistent ( )
inline

A Persistent with no storage cell.

Definition at line 639 of file v8.h.

References Local< T >::PersistentBase.

◆ Persistent() [2/5]

V8_INLINE Persistent ( Isolate *  isolate,
Local< S >  that 
)
inline

Construct a Persistent from a Local. When the Local is non-empty, a new storage cell is created pointing to the same object, and no flags are set.

Definition at line 646 of file v8.h.

References Local< T >::PersistentBase.

◆ Persistent() [3/5]

V8_INLINE Persistent ( Isolate *  isolate,
const Persistent< S, M2 > &  that 
)
inline

Construct a Persistent from a Persistent. When the Persistent is non-empty, a new storage cell is created pointing to the same object, and no flags are set.

Definition at line 656 of file v8.h.

References Local< T >::PersistentBase.

◆ Persistent() [4/5]

V8_INLINE Persistent ( const Persistent< T, M > &  that)
inline

The copy constructors and assignment operator create a Persistent exactly as the Persistent constructor, but the Copy function from the traits class is called, allowing the setting of flags based on the copied Persistent.

Definition at line 666 of file v8.h.

References Local< T >::PersistentBase.

◆ Persistent() [5/5]

V8_INLINE Persistent ( const Persistent< S, M2 > &  that)
inline

Definition at line 670 of file v8.h.

References Local< T >::PersistentBase.

◆ ~Persistent()

V8_INLINE ~Persistent ( )
inline

The destructor will dispose the Persistent based on the kResetInDestructor flags in the traits class. Since not calling dispose can result in a memory leak, it is recommended to always set this flag.

Definition at line 687 of file v8.h.

Member Function Documentation

◆ As()

V8_INLINE Persistent<S>& As ( ) const
inline

Definition at line 704 of file v8.h.

References Local< T >::Persistent.

◆ Cast()

static V8_INLINE Persistent<T>& Cast ( const Persistent< S > &  that)
inlinestatic

Definition at line 693 of file v8.h.

References Local< T >::Persistent.

◆ Copy()

void Copy ( const Persistent< S, M2 > &  that)

Definition at line 10038 of file v8.h.

◆ operator=() [1/2]

V8_INLINE Persistent& operator= ( const Persistent< T, M > &  that)
inline

Definition at line 673 of file v8.h.

◆ operator=() [2/2]

V8_INLINE Persistent& operator= ( const Persistent< S, M2 > &  that)
inline

Definition at line 678 of file v8.h.

Friends And Related Function Documentation

◆ Isolate

friend class Isolate
friend

Definition at line 709 of file v8.h.

◆ Local

friend class Local
friend

Definition at line 711 of file v8.h.

◆ Persistent

friend class Persistent
friend

Definition at line 712 of file v8.h.

◆ ReturnValue

friend class ReturnValue
friend

Definition at line 713 of file v8.h.

◆ Utils

friend class Utils
friend

Definition at line 710 of file v8.h.

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