#include <v8-array-buffer.h>

Inheritance diagram for v8::ArrayBuffer:

Collaboration diagram for v8::ArrayBuffer:

Classes
class	Allocator

Public Member Functions
size_t	ByteLength () const

size_t	MaxByteLength () const

bool	IsDetachable () const

bool	WasDetached () const

void	Detach ()

Maybe< bool >	Detach (v8::Local< v8::Value > key)

void	SetDetachKey (v8::Local< v8::Value > key)

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)

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

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, AccessorNameSetterCallback 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 ()

Local< Value >	GetPrototypeV2 ()

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

Maybe< bool >	SetPrototypeV2 (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)

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

void	SetAlignedPointerInInternalField (int index, void *value)

void	SetAlignedPointerInInternalFields (int argc, int indices[], void *values[])

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)

void *	GetAlignedPointerFromEmbedderDataInCreationContext (int index)

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[])

Isolate *	GetIsolate ()

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	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	IsWasmModuleObject () const

bool	IsWasmNull () const

bool	IsModuleNamespaceObject () 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)

template<>
Value *	Cast (Data *value)

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

bool	IsModule () const

bool	IsFixedArray () const

bool	IsPrivate () const

bool	IsObjectTemplate () const

bool	IsFunctionTemplate () const

bool	IsContext () const

Static Public Member Functions
static MaybeLocal< ArrayBuffer >	MaybeNew (Isolate *isolate, size_t byte_length, BackingStoreInitializationMode initialization_mode=BackingStoreInitializationMode::kZeroInitialized)

static Local< ArrayBuffer >	New (Isolate *isolate, size_t byte_length, BackingStoreInitializationMode initialization_mode=BackingStoreInitializationMode::kZeroInitialized)

static Local< ArrayBuffer >	New (Isolate *isolate, std::shared_ptr< BackingStore > backing_store)

static std::unique_ptr< BackingStore >	NewBackingStore (Isolate *isolate, size_t byte_length, BackingStoreInitializationMode initialization_mode=BackingStoreInitializationMode::kZeroInitialized)

static std::unique_ptr< BackingStore >	NewBackingStore (void data, size_t byte_length, v8::BackingStore::DeleterCallback deleter, void deleter_data)

static std::unique_ptr< BackingStore >	NewResizableBackingStore (size_t byte_length, size_t max_byte_length)

static ArrayBuffer *	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)

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

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, void wrappable)

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

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

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

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

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

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

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

static Isolate *	GetIsolate (const TracedReference< Object > &handle)

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

Detailed Description

An instance of the built-in ArrayBuffer constructor (ES6 draft 15.13.5).

Member Function Documentation

◆ ByteLength()

size_t v8::ArrayBuffer::ByteLength ( ) const

Data length in bytes.

◆ Cast()

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

inlinestatic

◆ Data()

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

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

◆ Detach() [1/2]

void v8::ArrayBuffer::Detach ( )

Detaches this ArrayBuffer and all its views (typed arrays). Detaching sets the byte length of the buffer and all typed arrays to zero, preventing JavaScript from ever accessing underlying backing store. ArrayBuffer should have been externalized and must be detachable.

◆ Detach() [2/2]

Maybe< bool > v8::ArrayBuffer::Detach ( v8::Local< v8::Value > key )

Detaches this ArrayBuffer and all its views (typed arrays). Detaching sets the byte length of the buffer and all typed arrays to zero, preventing JavaScript from ever accessing underlying backing store. ArrayBuffer should have been externalized and must be detachable. Returns Nothing if the key didn't pass the [[ArrayBufferDetachKey]] check, Just(true) otherwise.

◆ GetBackingStore()

std::shared_ptr< BackingStore > v8::ArrayBuffer::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::ArrayBuffer::IsDetachable ( ) const

Returns true if this ArrayBuffer may be detached.

◆ IsResizableByUserJavaScript()

bool v8::ArrayBuffer::IsResizableByUserJavaScript ( ) const

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

◆ MaxByteLength()

size_t v8::ArrayBuffer::MaxByteLength ( ) const

Maximum length in bytes.

◆ MaybeNew()

static MaybeLocal< ArrayBuffer > v8::ArrayBuffer::MaybeNew	(	Isolate *	isolate,
		size_t	byte_length,
		BackingStoreInitializationMode	initialization_mode = `BackingStoreInitializationMode::kZeroInitialized`
	)

static

Attempt to create a new ArrayBuffer. Allocate |byte_length| bytes. Allocated memory will be owned by a created ArrayBuffer and will be deallocated when it is garbage-collected, unless the object is externalized. If allocation fails, the Maybe returned will be empty.

◆ New() [1/2]

static Local< ArrayBuffer > v8::ArrayBuffer::New	(	Isolate *	isolate,
		size_t	byte_length,
		BackingStoreInitializationMode	initialization_mode = `BackingStoreInitializationMode::kZeroInitialized`
	)

static

Create a new ArrayBuffer. Allocate |byte_length| bytes, which are either zero-initialized or uninitialized. Allocated memory will be owned by a created ArrayBuffer and will be deallocated when it is garbage-collected, unless the object is externalized.

◆ New() [2/2]

static Local< ArrayBuffer > v8::ArrayBuffer::New	(	Isolate *	isolate,
		std::shared_ptr< BackingStore >	backing_store
	)

static

Create a new ArrayBuffer with an existing backing store. The created array keeps a reference to the backing store until the array is garbage collected. Note that the IsExternal bit does not affect this reference from the array to the backing store.

In future IsExternal bit will be removed. Until then the bit is set as follows. If the backing store does not own the underlying buffer, then the array is created in externalized state. Otherwise, the array is created in internalized state. In the latter case the array can be transitioned to the externalized state using Externalize(backing_store).

◆ NewBackingStore() [1/2]

static std::unique_ptr< BackingStore > v8::ArrayBuffer::NewBackingStore	(	Isolate *	isolate,
		size_t	byte_length,
		BackingStoreInitializationMode	initialization_mode = `BackingStoreInitializationMode::kZeroInitialized`
	)

static

Returns a new standalone BackingStore that is allocated using the array buffer allocator of the isolate. The allocation can either be zero intialized, or uninitialized. The result can be later passed to ArrayBuffer::New.

If the allocator returns nullptr, then the function may cause GCs in the given isolate and re-try the allocation. If GCs do not help, then the function will crash with an out-of-memory error.

◆ NewBackingStore() [2/2]

static std::unique_ptr< BackingStore > v8::ArrayBuffer::NewBackingStore	(	void *	data,
		size_t	byte_length,
		v8::BackingStore::DeleterCallback	deleter,
		void *	deleter_data
	)

static

Returns a new standalone BackingStore that takes over the ownership of the given buffer. The destructor of the BackingStore invokes the given deleter callback.

The result can be later passed to ArrayBuffer::New. The raw pointer to the buffer must not be passed again to any V8 API function.

◆ NewResizableBackingStore()

static std::unique_ptr< BackingStore > v8::ArrayBuffer::NewResizableBackingStore	(	size_t	byte_length,
		size_t	max_byte_length
	)

static

Returns a new resizable standalone BackingStore that is allocated using the array buffer allocator of the isolate. The result can be later passed to ArrayBuffer::New.

|byte_length| must be <= |max_byte_length|.

This function is usable without an isolate. Unlike |NewBackingStore| calls with an isolate, GCs cannot be triggered, and there are no retries. Allocation failure will cause the function to crash with an out-of-memory error.

◆ SetDetachKey()

void v8::ArrayBuffer::SetDetachKey ( v8::Local< v8::Value > key )

Sets the ArrayBufferDetachKey.

◆ WasDetached()

bool v8::ArrayBuffer::WasDetached ( ) const

Returns true if this ArrayBuffer has been detached.

Member Data Documentation

◆ kEmbedderFieldCount

constexpr int v8::ArrayBuffer::kEmbedderFieldCount = kInternalFieldCount

staticconstexpr

◆ kInternalFieldCount

constexpr int v8::ArrayBuffer::kInternalFieldCount

staticconstexpr

Initial value:

=

2

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

include/v8-array-buffer.h

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ ByteLength()

◆ Cast()

◆ Data()

◆ Detach() [1/2]

◆ Detach() [2/2]

◆ GetBackingStore()

◆ IsDetachable()

◆ IsResizableByUserJavaScript()

◆ MaxByteLength()

◆ MaybeNew()

◆ New() [1/2]

◆ New() [2/2]

◆ NewBackingStore() [1/2]

◆ NewBackingStore() [2/2]

◆ NewResizableBackingStore()

◆ SetDetachKey()

◆ WasDetached()

Member Data Documentation

◆ kEmbedderFieldCount

◆ kInternalFieldCount