WrapperDescriptor Struct Reference

#include <v8-cppgc.h>

Public Types
using	InternalFieldIndex = int

Public Member Functions
constexpr	WrapperDescriptor (InternalFieldIndex wrappable_type_index, InternalFieldIndex wrappable_instance_index, uint16_t embedder_id_for_garbage_collected)

Data Fields
InternalFieldIndex	wrappable_type_index
InternalFieldIndex	wrappable_instance_index
uint16_t	embedder_id_for_garbage_collected

Static Public Attributes
static constexpr uint16_t	kUnknownEmbedderId = UINT16_MAX

Detailed Description

Describes how V8 wrapper objects maintain references to garbage-collected C++ objects.

Definition at line 34 of file v8-cppgc.h.

Member Typedef Documentation

InternalFieldIndex

using InternalFieldIndex = int

The index used on v8::Ojbect::SetAlignedPointerFromInternalField() and related APIs to add additional data to an object which is used to identify JS->C++ references.

Definition at line 40 of file v8-cppgc.h.

Constructor & Destructor Documentation

WrapperDescriptor()

constexpr WrapperDescriptor ( InternalFieldIndex  wrappable_type_index, InternalFieldIndex  wrappable_instance_index, uint16_t  embedder_id_for_garbage_collected  )

inlineconstexpr

Definition at line 48 of file v8-cppgc.h.

References WrapperDescriptor::embedder_id_for_garbage_collected, WrapperDescriptor::wrappable_instance_index, and WrapperDescriptor::wrappable_type_index.

Field Documentation

embedder_id_for_garbage_collected

uint16_t embedder_id_for_garbage_collected

Embedder id identifying instances of garbage-collected objects. It is expected that the first field of the wrappable type is a uint16_t holding the id. Only references to instances of wrappables types with an id of embedder_id_for_garbage_collected will be considered by CppHeap.

Definition at line 71 of file v8-cppgc.h.

Referenced by WrapperDescriptor::WrapperDescriptor().

kUnknownEmbedderId

constexpr uint16_t kUnknownEmbedderId = UINT16_MAX

staticconstexpr

Unknown embedder id. The value is reserved for internal usages and must not be used with CppHeap.

Definition at line 46 of file v8-cppgc.h.

wrappable_instance_index

InternalFieldIndex wrappable_instance_index

Index of the wrappable instance.

Definition at line 63 of file v8-cppgc.h.

Referenced by WrapperDescriptor::WrapperDescriptor().

wrappable_type_index

InternalFieldIndex wrappable_type_index

Index of the wrappable type.

Definition at line 58 of file v8-cppgc.h.

Referenced by WrapperDescriptor::WrapperDescriptor().

---

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

• include/v8-cppgc.h