#include <v8-array-buffer.h>

Inheritance diagram for v8::ArrayBufferBase:

Collaboration diagram for v8::ArrayBufferBase:

Public Member Functions
size_t	ByteLength () const

size_t	MaxByteLength () const

bool	IsShared () const

bool	IsDetachable () const

bool	WasDetached () const

bool	IsImmutable () const

size_t	CopyArrayBufferBytes (size_t source_start, size_t bytes_to_copy, Local< ArrayBufferBase > target, size_t target_start) const

std::shared_ptr< BackingStore >	GetBackingStore ()

bool	IsResizableByUserJavaScript () const

void *	Data () const

Public Member Functions inherited from v8::Object
Maybe< bool >	Set (Local< Context > context, Local< Value > key, Local< Value > value)

Maybe< bool >	Set (Local< Context > context, Local< Value > key, Local< Value > value, MaybeLocal< Object > receiver)

Maybe< bool >	Set (Local< Context > context, uint32_t index, Local< Value > value)

Maybe< bool >	CreateDataProperty (Local< Context > context, Local< Name > key, Local< Value > value)

Maybe< bool >	CreateDataProperty (Local< Context > context, uint32_t index, Local< Value > value)

Maybe< bool >	DefineOwnProperty (Local< Context > context, Local< Name > key, Local< Value > value, PropertyAttribute attributes=None)

Maybe< bool >	DefineProperty (Local< Context > context, Local< Name > key, PropertyDescriptor &descriptor)

MaybeLocal< Value >	Get (Local< Context > context, Local< Value > key)

MaybeLocal< Value >	Get (Local< Context > context, Local< Value > key, MaybeLocal< Object > receiver)

MaybeLocal< Value >	Get (Local< Context > context, uint32_t index)

MaybeLocal< Value >	TryGetWithNoSideEffects (Local< Context > context, Local< Name > key)

Maybe< PropertyAttribute >	GetPropertyAttributes (Local< Context > context, Local< Value > key)

Maybe< bool >	GetPropertyAttributes (Local< Context > context, Local< Value > key, PropertyAttribute *out_attributes)

MaybeLocal< Value >	GetOwnPropertyDescriptor (Local< Context > context, Local< Name > key)

Maybe< bool >	Has (Local< Context > context, Local< Value > key)

Maybe< bool >	Delete (Local< Context > context, Local< Value > key)

Maybe< bool >	Has (Local< Context > context, uint32_t index)

Maybe< bool >	Delete (Local< Context > context, uint32_t index)

void	SetAccessorProperty (Local< Name > name, Local< Function > getter, Local< Function > setter=Local< Function >(), PropertyAttribute attributes=None)

Maybe< bool >	SetNativeDataProperty (Local< Context > context, Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallbackV2 setter=nullptr, Local< Value > data=Local< Value >(), PropertyAttribute attributes=None, SideEffectType getter_side_effect_type=SideEffectType::kHasSideEffect, SideEffectType setter_side_effect_type=SideEffectType::kHasSideEffect)

Maybe< bool >	SetLazyDataProperty (Local< Context > context, Local< Name > name, AccessorNameGetterCallback getter, Local< Value > data=Local< Value >(), PropertyAttribute attributes=None, SideEffectType getter_side_effect_type=SideEffectType::kHasSideEffect, SideEffectType setter_side_effect_type=SideEffectType::kHasSideEffect)

Maybe< bool >	HasPrivate (Local< Context > context, Local< Private > key)

Maybe< bool >	SetPrivate (Local< Context > context, Local< Private > key, Local< Value > value)

Maybe< bool >	DeletePrivate (Local< Context > context, Local< Private > key)

MaybeLocal< Value >	GetPrivate (Local< Context > context, Local< Private > key)

MaybeLocal< Array >	GetPropertyNames (Local< Context > context)

MaybeLocal< Array >	GetPropertyNames (Local< Context > context, KeyCollectionMode mode, PropertyFilter property_filter, IndexFilter index_filter, KeyConversionMode key_conversion=KeyConversionMode::kKeepNumbers)

MaybeLocal< Array >	GetOwnPropertyNames (Local< Context > context)

MaybeLocal< Array >	GetOwnPropertyNames (Local< Context > context, PropertyFilter filter, KeyConversionMode key_conversion=KeyConversionMode::kKeepNumbers)

Local< Value >	GetPrototype ()

Maybe< bool >	SetPrototype (Local< Context > context, Local< Value > prototype)

Local< Object >	FindInstanceInPrototypeChain (Local< FunctionTemplate > tmpl)

MaybeLocal< String >	ObjectProtoToString (Local< Context > context)

Local< String >	GetConstructorName ()

Maybe< bool >	SetIntegrityLevel (Local< Context > context, IntegrityLevel level)

int	InternalFieldCount () const

Local< Data >	GetInternalField (int index)

void	SetInternalField (int index, Local< Data > data)

void *	GetAlignedPointerFromInternalField (int index, EmbedderDataTypeTag tag)

void *	GetAlignedPointerFromInternalField (v8::Isolate *isolate, int index, EmbedderDataTypeTag tag)

void	SetAlignedPointerInInternalField (int index, void *value, EmbedderDataTypeTag tag)

Maybe< bool >	HasOwnProperty (Local< Context > context, Local< Name > key)

Maybe< bool >	HasOwnProperty (Local< Context > context, uint32_t index)

Maybe< bool >	HasRealNamedProperty (Local< Context > context, Local< Name > key)

Maybe< bool >	HasRealIndexedProperty (Local< Context > context, uint32_t index)

Maybe< bool >	HasRealNamedCallbackProperty (Local< Context > context, Local< Name > key)

MaybeLocal< Value >	GetRealNamedPropertyInPrototypeChain (Local< Context > context, Local< Name > key)

Maybe< PropertyAttribute >	GetRealNamedPropertyAttributesInPrototypeChain (Local< Context > context, Local< Name > key)

MaybeLocal< Value >	GetRealNamedProperty (Local< Context > context, Local< Name > key)

Maybe< PropertyAttribute >	GetRealNamedPropertyAttributes (Local< Context > context, Local< Name > key)

bool	HasNamedLookupInterceptor () const

bool	HasIndexedLookupInterceptor () const

int	GetIdentityHash ()

Local< Object >	Clone (v8::Isolate *isolate)

Local< Object >	Clone ()

MaybeLocal< Context >	GetCreationContext (v8::Isolate *isolate)

MaybeLocal< Context >	GetCreationContext ()

Local< Context >	GetCreationContextChecked (v8::Isolate *isolate)

Local< Context >	GetCreationContextChecked ()

void *	GetAlignedPointerFromEmbedderDataInCreationContext (v8::Isolate *isolate, int index, EmbedderDataTypeTag tag)

void *	GetAlignedPointerFromEmbedderDataInCreationContext (int index, EmbedderDataTypeTag tag)

void *	GetAlignedPointerFromEmbedderDataInCreationContext (v8::Isolate *isolate, int index, CppHeapPointerTag tag)

bool	IsCallable () const

bool	IsConstructor () const

bool	IsApiWrapper () const

bool	IsUndetectable () const

MaybeLocal< Value >	CallAsFunction (Local< Context > context, Local< Value > recv, int argc, Local< Value > argv[])

MaybeLocal< Value >	CallAsConstructor (Local< Context > context, int argc, Local< Value > argv[])

MaybeLocal< Array >	PreviewEntries (bool *is_key_value)

bool	IsCodeLike (Isolate *isolate) const

Public Member Functions inherited from v8::Value
bool	IsUndefined () const

bool	IsNull () const

bool	IsNullOrUndefined () const

bool	IsTrue () const

bool	IsFalse () const

bool	IsName () const

bool	IsString () const

bool	IsSymbol () const

bool	IsFunction () const

bool	IsArray () const

bool	IsObject () const

bool	IsBigInt () const

bool	IsBoolean () const

bool	IsNumber () const

bool	IsExternal () const

bool	IsInt32 () const

bool	IsUint32 () const

bool	IsDate () const

bool	IsArgumentsObject () const

bool	IsBigIntObject () const

bool	IsBooleanObject () const

bool	IsNumberObject () const

bool	IsStringObject () const

bool	IsSymbolObject () const

bool	IsNativeError () const

bool	IsRegExp () const

bool	IsAsyncFunction () const

bool	IsGeneratorFunction () const

bool	IsGeneratorObject () const

bool	IsPromise () const

bool	IsMap () const

bool	IsSet () const

bool	IsMapIterator () const

bool	IsSetIterator () const

bool	IsWeakMap () const

bool	IsWeakSet () const

bool	IsWeakRef () const

bool	IsArrayBufferBase () const

bool	IsArrayBuffer () const

bool	IsArrayBufferView () const

bool	IsTypedArray () const

bool	IsUint8Array () const

bool	IsUint8ClampedArray () const

bool	IsInt8Array () const

bool	IsUint16Array () const

bool	IsInt16Array () const

bool	IsUint32Array () const

bool	IsInt32Array () const

bool	IsFloat16Array () const

bool	IsFloat32Array () const

bool	IsFloat64Array () const

bool	IsBigInt64Array () const

bool	IsBigUint64Array () const

bool	IsDataView () const

bool	IsSharedArrayBuffer () const

bool	IsProxy () const

bool	IsWasmMemoryObject () const

bool	IsWasmMemoryMapDescriptor () const

bool	IsWasmModuleObject () const

bool	IsWasmNull () const

bool	IsModuleNamespaceObject () const

bool	IsDeferredModuleNamespaceObject () const

bool	IsPrimitive () const

MaybeLocal< Primitive >	ToPrimitive (Local< Context > context) const

MaybeLocal< Numeric >	ToNumeric (Local< Context > context) const

MaybeLocal< BigInt >	ToBigInt (Local< Context > context) const

MaybeLocal< Number >	ToNumber (Local< Context > context) const

MaybeLocal< String >	ToString (Local< Context > context) const

MaybeLocal< String >	ToDetailString (Local< Context > context) const

MaybeLocal< Object >	ToObject (Local< Context > context) const

MaybeLocal< Integer >	ToInteger (Local< Context > context) const

MaybeLocal< Uint32 >	ToUint32 (Local< Context > context) const

MaybeLocal< Int32 >	ToInt32 (Local< Context > context) const

Local< Boolean >	ToBoolean (Isolate *isolate) const

MaybeLocal< Uint32 >	ToArrayIndex (Local< Context > context) const

bool	BooleanValue (Isolate *isolate) const

Maybe< double >	NumberValue (Local< Context > context) const

Maybe< int64_t >	IntegerValue (Local< Context > context) const

Maybe< uint32_t >	Uint32Value (Local< Context > context) const

Maybe< int32_t >	Int32Value (Local< Context > context) const

Maybe< bool >	Equals (Local< Context > context, Local< Value > that) const

bool	StrictEquals (Local< Value > that) const

bool	SameValue (Local< Value > that) const

Local< String >	TypeOf (Isolate *)

Maybe< bool >	InstanceOf (Local< Context > context, Local< Object > object)

uint32_t	GetHash ()

template<>
Value *	Cast (Data *value)

Public Member Functions inherited from v8::Data
bool	IsValue () const

bool	IsModule () const

bool	IsModuleRequest () const

bool	IsFixedArray () const

bool	IsPrivate () const

bool	IsObjectTemplate () const

bool	IsFunctionTemplate () const

bool	IsDictionaryTemplate () const

bool	IsContext () const

bool	IsCppHeapExternal () const

Static Public Member Functions
static ArrayBufferBase *	Cast (Value *value)

Static Public Member Functions inherited from v8::Object
static int	InternalFieldCount (const PersistentBase< Object > &object)

static int	InternalFieldCount (const BasicTracedReference< Object > &object)

static void *	GetAlignedPointerFromInternalField (const PersistentBase< Object > &object, int index, EmbedderDataTypeTag tag)

static void *	GetAlignedPointerFromInternalField (const BasicTracedReference< Object > &object, int index, EmbedderDataTypeTag tag)

template<CppHeapPointerTag tag, typename T = void>
static T *	Unwrap (v8::Isolate *isolate, const v8::Local< v8::Object > &wrapper)

template<CppHeapPointerTag tag, typename T = void>
static T *	Unwrap (v8::Isolate *isolate, const PersistentBase< Object > &wrapper)

template<CppHeapPointerTag tag, typename T = void>
static T *	Unwrap (v8::Isolate *isolate, const BasicTracedReference< Object > &wrapper)

template<typename T = void>
static T *	Unwrap (v8::Isolate *isolate, const v8::Local< v8::Object > &wrapper, CppHeapPointerTagRange tag_range)

template<typename T = void>
static T *	Unwrap (v8::Isolate *isolate, const PersistentBase< Object > &wrapper, CppHeapPointerTagRange tag_range)

template<typename T = void>
static T *	Unwrap (v8::Isolate *isolate, const BasicTracedReference< Object > &wrapper, CppHeapPointerTagRange tag_range)

template<CppHeapPointerTag tag>
static void	Wrap (v8::Isolate isolate, const v8::Local< v8::Object > &wrapper, Wrappable wrappable)

template<CppHeapPointerTag tag>
static void	Wrap (v8::Isolate isolate, const PersistentBase< Object > &wrapper, Wrappable wrappable)

template<CppHeapPointerTag tag>
static void	Wrap (v8::Isolate isolate, const BasicTracedReference< Object > &wrapper, Wrappable wrappable)

static void	Wrap (v8::Isolate isolate, const v8::Local< v8::Object > &wrapper, Wrappable wrappable, CppHeapPointerTag tag)

static void	Wrap (v8::Isolate isolate, const PersistentBase< Object > &wrapper, Wrappable wrappable, CppHeapPointerTag tag)

static void	Wrap (v8::Isolate isolate, const BasicTracedReference< Object > &wrapper, Wrappable wrappable, CppHeapPointerTag tag)

static void	WrapGlobal (v8::Isolate isolate, const v8::Local< v8::Object > &wrapper, Wrappable wrappable, CppHeapPointerTag tag)

static bool	CheckGlobalWrappable (v8::Isolate *isolate, const v8::Local< v8::Object > &wrapper, CppHeapPointerTagRange tag_range)

static MaybeLocal< Context >	GetCreationContext (v8::Isolate *isolate, const PersistentBase< Object > &object)

static MaybeLocal< Context >	GetCreationContext (const PersistentBase< Object > &object)

static Local< Object >	New (Isolate *isolate)

static Local< Object >	New (Isolate isolate, Local< Value > prototype_or_null, Local< Name > names, Local< Value > *values, size_t length)

static Object *	Cast (Value *obj)

Static Public Member Functions inherited from v8::Value
template<class T >
static Value *	Cast (T *value)

Static Public Attributes
static constexpr int	kInternalFieldCount

static constexpr int	kEmbedderFieldCount = kInternalFieldCount

static constexpr size_t	kMaxByteLength

Friends
class	ArrayBuffer

class	SharedArrayBuffer

Detailed Description

A base class for an instance of the built-in ArrayBuffer or SharedArrayBuffer constructor.

Member Function Documentation

◆ ByteLength()

size_t v8::ArrayBufferBase::ByteLength ( ) const

Data length in bytes.

◆ Cast()

static ArrayBufferBase * v8::ArrayBufferBase::Cast ( Value * value )

inlinestatic

◆ CopyArrayBufferBytes()

size_t v8::ArrayBufferBase::CopyArrayBufferBytes	(	size_t	source_start,
		size_t	bytes_to_copy,
		Local< ArrayBufferBase >	target,
		size_t	target_start
	)		const

Copy up to |bytes_to_copy| bytes from this ArrayBufferBase starting at position |source_start| to the target ArrayBufferBase starting at position |target_start|. Nothing is copied if the source or target ArrayBuffer is detached, or if the target ArrayBuffer is immutable. Returns the number of bytes actually copied.

◆ Data()

void * v8::ArrayBufferBase::Data ( ) const

More efficient shortcut for GetBackingStore()->Data(). The returned pointer is valid as long as the ArrayBuffer is alive.

◆ GetBackingStore()

std::shared_ptr< BackingStore > v8::ArrayBufferBase::GetBackingStore ( )

Get a shared pointer to the backing store of this array buffer. This pointer coordinates the lifetime management of the internal storage with any live ArrayBuffers on the heap, even across isolates. The embedder should not attempt to manage lifetime of the storage through other means.

The returned shared pointer will not be empty, even if the ArrayBuffer has been detached. Use |WasDetached| to tell if it has been detached instead.

◆ IsDetachable()

bool v8::ArrayBufferBase::IsDetachable ( ) const

Returns true if this ArrayBuffer may be detached. Always false for SharedArrayBuffer.

◆ IsImmutable()

bool v8::ArrayBufferBase::IsImmutable ( ) const

Returns true if this ArrayBuffer is immutable. Always false for SharedArrayBuffer.

◆ IsResizableByUserJavaScript()

bool v8::ArrayBufferBase::IsResizableByUserJavaScript ( ) const

More efficient shortcut for GetBackingStore()->IsResizableByUserJavaScript().

◆ IsShared()

bool v8::ArrayBufferBase::IsShared ( ) const

Returns true if this is a SharedArrayBuffer, false if it is an ArrayBuffer.

◆ MaxByteLength()

size_t v8::ArrayBufferBase::MaxByteLength ( ) const

Maximum length in bytes.

◆ WasDetached()

bool v8::ArrayBufferBase::WasDetached ( ) const

Returns true if this ArrayBuffer has been detached. Always false for SharedArrayBuffer.

Friends And Related Function Documentation

◆ ArrayBuffer

friend class ArrayBuffer

friend

◆ SharedArrayBuffer

friend class SharedArrayBuffer

friend

Member Data Documentation

◆ kEmbedderFieldCount

constexpr int v8::ArrayBufferBase::kEmbedderFieldCount = kInternalFieldCount

staticconstexpr

◆ kInternalFieldCount

constexpr int v8::ArrayBufferBase::kInternalFieldCount

staticconstexpr

Initial value:

=

2

◆ kMaxByteLength

constexpr size_t v8::ArrayBufferBase::kMaxByteLength

staticconstexpr

Initial value:

=

static_cast<size_t>((uint64_t{1} << 53) - 1)

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

include/v8-array-buffer.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Function Documentation

◆ ByteLength()

◆ Cast()

◆ CopyArrayBufferBytes()

◆ Data()

◆ GetBackingStore()

◆ IsDetachable()

◆ IsImmutable()

◆ IsResizableByUserJavaScript()

◆ IsShared()

◆ MaxByteLength()

◆ WasDetached()

Friends And Related Function Documentation

◆ ArrayBuffer

◆ SharedArrayBuffer

Member Data Documentation

◆ kEmbedderFieldCount

◆ kInternalFieldCount

◆ kMaxByteLength