#include <v8-persistent-handle.h>

Inheritance diagram for v8::Persistent< T, M >:

Collaboration diagram for v8::Persistent< T, M >:

Public Member Functions
V8_INLINE	Persistent ()=default

template<class S > requires (std::is_base_of_v<T, S>)
V8_INLINE	Persistent (Isolate *isolate, Local< S > that)

template<class S , class M2 > requires (std::is_base_of_v<T, S>)
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 , class M2 >
V8_INLINE Persistent< S, M2 > &	As () const

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

Public Member Functions inherited from v8::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 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)

template<typename P >
P *	ClearWeak ()

Public Member Functions inherited from v8::api_internal::IndirectHandleBase
V8_INLINE bool	IsEmpty () const

V8_INLINE void	Clear ()

Static Public Member Functions
template<class S , class M2 >
static V8_INLINE Persistent< T, M > &	Cast (const Persistent< S, M2 > &that)

Private Member Functions
template<class S , class M2 >
V8_INLINE void	Copy (const Persistent< S, M2 > &that)

Friends
class	Isolate

class	Utils

template<class F >
class	Local

template<class F1 , class F2 >
class	Persistent

template<class F >
class	ReturnValue

Additional Inherited Members
Protected Member Functions inherited from v8::api_internal::IndirectHandleBase
V8_INLINE	IndirectHandleBase ()=default

V8_INLINE	IndirectHandleBase (const IndirectHandleBase &other)=default

V8_INLINE IndirectHandleBase &	operator= (const IndirectHandleBase &that)=default

V8_INLINE	IndirectHandleBase (internal::Address *location)

V8_INLINE internal::Address	ptr () const

V8_INLINE internal::Address *const &	slot () const

V8_INLINE internal::Address *&	slot ()

template<typename T , bool check_null = false>
V8_INLINE T *	value () const

V8_INLINE internal::ValueHelper::InternalRepresentationType	repr () const

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.

CAVEAT: Persistent objects do not have proper destruction behavior by default and as such will leak the object without explicit clear. Consider using v8::Global instead which has proper destruction and move semantics.

Definition at line 250 of file v8-persistent-handle.h.

Constructor & Destructor Documentation

◆ Persistent() [1/5]

template<class T , class M >

V8_INLINE v8::Persistent< T, M >::Persistent ( )

default

A Persistent with no storage cell.

◆ Persistent() [2/5]

template<class T , class M >

template<class S >
requires (std::is_base_of_v<T, S>)

V8_INLINE v8::Persistent< T, M >::Persistent	(	Isolate *	isolate,
		Local< S >	that )

inline

Construct a Persistent from a Local with automatic up casting. 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 264 of file v8-persistent-handle.h.

◆ Persistent() [3/5]

template<class T , class M >

template<class S , class M2 >
requires (std::is_base_of_v<T, S>)

V8_INLINE v8::Persistent< T, M >::Persistent	(	Isolate *	isolate,
		const Persistent< S, M2 > &	that )

inline

Construct a Persistent from a Persistent with automatic up casting. 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 275 of file v8-persistent-handle.h.

◆ Persistent() [4/5]

template<class T , class M >

V8_INLINE v8::Persistent< T, M >::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 285 of file v8-persistent-handle.h.

Here is the call graph for this function:

◆ Persistent() [5/5]

template<class T , class M >

template<class S , class M2 >

V8_INLINE v8::Persistent< T, M >::Persistent ( const Persistent< S, M2 > & that )

inline

Definition at line 289 of file v8-persistent-handle.h.

Here is the call graph for this function:

◆ ~Persistent()

template<class T , class M >

V8_INLINE v8::Persistent< T, M >::~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 307 of file v8-persistent-handle.h.

Here is the call graph for this function:

Member Function Documentation

◆ As()

template<class T , class M >

template<class S , class M2 >

V8_INLINE Persistent< S, M2 > & v8::Persistent< T, M >::As ( ) const

inline

Definition at line 325 of file v8-persistent-handle.h.

Here is the call graph for this function:

◆ Cast()

template<class T , class M >

template<class S , class M2 >

static V8_INLINE Persistent< T, M > & v8::Persistent< T, M >::Cast ( const Persistent< S, M2 > & that )

inlinestatic

Definition at line 313 of file v8-persistent-handle.h.

Here is the caller graph for this function:

◆ Copy() [1/2]

template<class T , class M >

template<class S , class M2 >

V8_INLINE void v8::Persistent< T, M >::Copy ( const Persistent< S, M2 > & that )

private

Here is the caller graph for this function:

◆ Copy() [2/2]

template<class T , class M >

template<class S , class M2 >

void v8::Persistent< T, M >::Copy ( const Persistent< S, M2 > & that )

Definition at line 433 of file v8-persistent-handle.h.

Here is the call graph for this function:

◆ operator=() [1/2]

template<class T , class M >

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

inline

Definition at line 292 of file v8-persistent-handle.h.

Here is the call graph for this function:

◆ operator=() [2/2]

template<class T , class M >

template<class S , class M2 >

V8_INLINE Persistent & v8::Persistent< T, M >::operator= ( const Persistent< S, M2 > & that )

inline

Definition at line 297 of file v8-persistent-handle.h.

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ Isolate

template<class T , class M >

friend class Isolate

friend

Definition at line 330 of file v8-persistent-handle.h.

◆ Local

template<class T , class M >

template<class F >

friend class Local

friend

Definition at line 333 of file v8-persistent-handle.h.

◆ Persistent

template<class T , class M >

template<class F1 , class F2 >

friend class Persistent

friend

Persistent is a way to create a strong pointer from an off-heap object to another on-heap object. As long as the Persistent handle is alive the GC will keep the object pointed to alive. The Persistent handle is always a GC root from the point of view of the GC. Persistent must be constructed and destructed in the same thread.

Definition at line 335 of file v8-persistent-handle.h.

◆ ReturnValue

template<class T , class M >

template<class F >

friend class ReturnValue

friend

Definition at line 337 of file v8-persistent-handle.h.

◆ Utils

template<class T , class M >

friend class Utils

friend

Definition at line 331 of file v8-persistent-handle.h.

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

include/v8-local-handle.h
include/v8-persistent-handle.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Persistent() [1/5]

◆ Persistent() [2/5]

◆ Persistent() [3/5]

◆ Persistent() [4/5]

◆ Persistent() [5/5]

◆ ~Persistent()

Member Function Documentation

◆ As()

◆ Cast()

◆ Copy() [1/2]

◆ Copy() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

Friends And Related Symbol Documentation

◆ Isolate

◆ Local

◆ Persistent

◆ ReturnValue

◆ Utils