#include <v8.h>

Inheritance diagram for v8::ArrayBuffer:

Collaboration diagram for v8::ArrayBuffer:

Classes
class	Allocator

class	Contents

Public Member Functions
size_t	ByteLength () const

bool	IsExternal () const

bool	IsNeuterable () const

void	Neuter ()

Contents	Externalize ()

Contents	GetContents ()

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

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

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

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)

Maybe< bool >	ForceSet (Local< Context > context, Local< Value > key, Local< Value > value, PropertyAttribute attribs=None)

Local< Value >	Get (Local< Value > key)

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

Local< Value >	Get (uint32_t index)

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

PropertyAttribute	GetPropertyAttributes (Local< Value > key)

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

Local< Value >	GetOwnPropertyDescriptor (Local< Name > key)

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

bool	Has (Local< Value > key)

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

bool	Delete (Local< Value > key)

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

bool	Has (uint32_t index)

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

bool	Delete (uint32_t index)

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

bool	SetAccessor (Local< String > name, AccessorGetterCallback getter, AccessorSetterCallback setter=0, Local< Value > data=Local< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None)

bool	SetAccessor (Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=0, Local< Value > data=Local< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None)

Maybe< bool >	SetAccessor (Local< Context > context, Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=0, MaybeLocal< Value > data=MaybeLocal< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None)

void	SetAccessorProperty (Local< Name > name, Local< Function > getter, Local< Function > setter=Local< Function >(), PropertyAttribute attribute=None, AccessControl settings=DEFAULT)

Maybe< bool >	SetNativeDataProperty (Local< Context > context, Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=nullptr, Local< Value > data=Local< Value >(), PropertyAttribute attributes=None)

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)

Local< Array >	GetPropertyNames ()

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

MaybeLocal< Array >	GetPropertyNames (Local< Context > context, KeyCollectionMode mode, PropertyFilter property_filter, IndexFilter index_filter)

Local< Array >	GetOwnPropertyNames ()

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

MaybeLocal< Array >	GetOwnPropertyNames (Local< Context > context, PropertyFilter filter)

Local< Value >	GetPrototype ()

bool	SetPrototype (Local< Value > prototype)

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

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

Local< String >	ObjectProtoToString ()

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

Local< String >	GetConstructorName ()

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

int	InternalFieldCount ()

Local< Value >	GetInternalField (int index)

void	SetInternalField (int index, Local< Value > value)

void *	GetAlignedPointerFromInternalField (int index)

void	SetAlignedPointerInInternalField (int index, void *value)

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

bool	HasOwnProperty (Local< String > key)

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

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

bool	HasRealNamedProperty (Local< String > key)

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

bool	HasRealIndexedProperty (uint32_t index)

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

bool	HasRealNamedCallbackProperty (Local< String > key)

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

Local< Value >	GetRealNamedPropertyInPrototypeChain (Local< String > key)

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

Maybe< PropertyAttribute >	GetRealNamedPropertyAttributesInPrototypeChain (Local< String > key)

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

Local< Value >	GetRealNamedProperty (Local< String > key)

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

Maybe< PropertyAttribute >	GetRealNamedPropertyAttributes (Local< String > key)

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

bool	HasNamedLookupInterceptor ()

bool	HasIndexedLookupInterceptor ()

int	GetIdentityHash ()

Local< Object >	Clone ()

Local< Context >	CreationContext ()

bool	IsCallable ()

bool	IsConstructor ()

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

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

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

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

Isolate *	GetIsolate ()

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

bool	IsNumber () const

bool	IsExternal () const

bool	IsInt32 () const

bool	IsUint32 () const

bool	IsDate () const

bool	IsArgumentsObject () 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	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	IsFloat32Array () const

bool	IsFloat64Array () const

bool	IsDataView () const

bool	IsSharedArrayBuffer () const

bool	IsProxy () const

bool	IsWebAssemblyCompiledModule () const

MaybeLocal< Boolean >	ToBoolean (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

Local< Number >	ToNumber (Isolate *isolate) const

Local< String >	ToString (Isolate *isolate) const

Local< String >	ToDetailString (Isolate *isolate) const

Local< Object >	ToObject (Isolate *isolate) const

Local< Integer >	ToInteger (Isolate *isolate) const

Local< Uint32 >	ToUint32 (Isolate *isolate) const

Local< Int32 >	ToInt32 (Isolate *isolate) const

Local< Boolean >	ToBoolean () const

Local< Number >	ToNumber () const

Local< String >	ToString () const

Local< String >	ToDetailString () const

Local< Object >	ToObject () const

Local< Integer >	ToInteger () const

Local< Uint32 >	ToUint32 () const

Local< Int32 >	ToInt32 () const

Local< Uint32 >	ToArrayIndex () const

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

Maybe< bool >	BooleanValue (Local< Context > context) 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

bool	BooleanValue () const

double	NumberValue () const

int64_t	IntegerValue () const

uint32_t	Uint32Value () const

int32_t	Int32Value () const

bool	Equals (Local< Value > that) 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)

Static Public Member Functions
static Local< ArrayBuffer >	New (Isolate *isolate, size_t byte_length)

static Local< ArrayBuffer >	New (Isolate isolate, void data, size_t byte_length, ArrayBufferCreationMode mode=ArrayBufferCreationMode::kExternalized)

static ArrayBuffer *	Cast (Value *obj)

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

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

static Local< Context >	CreationContext (const PersistentBase< Object > &object)

static Local< Object >	New (Isolate *isolate)

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 const int	kInternalFieldCount = 2

static const int	kEmbedderFieldCount = 2

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

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

inlinestatic

◆ Externalize()

Contents v8::ArrayBuffer::Externalize ( )

Make this ArrayBuffer external. The pointer to underlying memory block and byte length are returned as |Contents| structure. After ArrayBuffer had been externalized, it does no longer own the memory block. The caller should take steps to free memory when it is no longer needed.

The memory block is guaranteed to be allocated with |Allocator::Allocate| that has been set via Isolate::CreateParams.

◆ GetContents()

Contents v8::ArrayBuffer::GetContents ( )

Get a pointer to the ArrayBuffer's underlying memory block without externalizing it. If the ArrayBuffer is not externalized, this pointer will become invalid as soon as the ArrayBuffer gets garbage collected.

The embedder should make sure to hold a strong reference to the ArrayBuffer while accessing this pointer.

The memory block is guaranteed to be allocated with |Allocator::Allocate|.

◆ IsExternal()

bool v8::ArrayBuffer::IsExternal ( ) const

Returns true if ArrayBuffer is externalized, that is, does not own its memory block.

◆ IsNeuterable()

bool v8::ArrayBuffer::IsNeuterable ( ) const

Returns true if this ArrayBuffer may be neutered.

◆ Neuter()

void v8::ArrayBuffer::Neuter ( )

Neuters this ArrayBuffer and all its views (typed arrays). Neutering 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 neuterable.

◆ New() [1/2]

static Local< ArrayBuffer > v8::ArrayBuffer::New	(	Isolate *	isolate,
		size_t	byte_length
	)

static

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.

◆ New() [2/2]

static Local< ArrayBuffer > v8::ArrayBuffer::New	(	Isolate *	isolate,
		void *	data,
		size_t	byte_length,
		ArrayBufferCreationMode	mode = `ArrayBufferCreationMode::kExternalized`
	)

static

Create a new ArrayBuffer over an existing memory block. The created array buffer is by default immediately in externalized state. In externalized state, the memory block will not be reclaimed when a created ArrayBuffer is garbage-collected. In internalized state, the memory block will be released using |Allocator::Free| once all ArrayBuffers referencing it are collected by the garbage collector.

Member Data Documentation

◆ kEmbedderFieldCount

const int v8::ArrayBuffer::kEmbedderFieldCount = 2

static

◆ kInternalFieldCount

const int v8::ArrayBuffer::kInternalFieldCount = 2

static

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

include/v8.h

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ ByteLength()

◆ Cast()

◆ Externalize()

◆ GetContents()

◆ IsExternal()

◆ IsNeuterable()

◆ Neuter()

◆ New() [1/2]

◆ New() [2/2]

Member Data Documentation

◆ kEmbedderFieldCount

◆ kInternalFieldCount