Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
v8::ArrayBufferView Class Reference

#include <v8-array-buffer.h>

Inheritance diagram for v8::ArrayBufferView:
[legend]
Collaboration diagram for v8::ArrayBufferView:
[legend]

Public Member Functions

Local< ArrayBuffer > Buffer ()
 
size_t ByteOffset ()
 
size_t ByteLength ()
 
size_t CopyContents (void *dest, size_t byte_length)
 
v8::MemorySpan< uint8_t > GetContents (v8::MemorySpan< uint8_t > storage)
 
bool HasBuffer () 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 IsWasmMemoryMapDescriptor () 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 ArrayBufferView * 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 const int kEmbedderFieldCount = kInternalFieldCount
 

Detailed Description

A base class for an instance of one of "views" over ArrayBuffer, including TypedArrays and DataView (ES6 draft 15.13).

Member Function Documentation

◆ Buffer()

Local< ArrayBuffer > v8::ArrayBufferView::Buffer ( )

Returns underlying ArrayBuffer.

◆ ByteLength()

size_t v8::ArrayBufferView::ByteLength ( )

Size of a view in bytes.

◆ ByteOffset()

size_t v8::ArrayBufferView::ByteOffset ( )

Byte offset in |Buffer|.

◆ Cast()

static ArrayBufferView * v8::ArrayBufferView::Cast ( Value *  value)
inlinestatic

◆ CopyContents()

size_t v8::ArrayBufferView::CopyContents ( void *  dest,
size_t  byte_length 
)

Copy the contents of the ArrayBufferView's buffer to an embedder defined memory without additional overhead that calling ArrayBufferView::Buffer might incur.

Will write at most min(|byte_length|, ByteLength) bytes starting at ByteOffset of the underlying buffer to the memory starting at |dest|. Returns the number of bytes actually written.

◆ GetContents()

v8::MemorySpan< uint8_t > v8::ArrayBufferView::GetContents ( v8::MemorySpan< uint8_t >  storage)

Returns the contents of the ArrayBufferView's buffer as a MemorySpan. If the contents are on the V8 heap, they get copied into storage. Otherwise a view into the off-heap backing store is returned. The provided storage should be at least as large as the maximum on-heap size of a TypedArray, was defined in gn with typed_array_max_size_in_heap. The default value is 64 bytes.

◆ HasBuffer()

bool v8::ArrayBufferView::HasBuffer ( ) const

Returns true if ArrayBufferView's backing ArrayBuffer has already been allocated.

Member Data Documentation

◆ kEmbedderFieldCount

const int v8::ArrayBufferView::kEmbedderFieldCount = kInternalFieldCount
static

◆ kInternalFieldCount

constexpr int v8::ArrayBufferView::kInternalFieldCount
staticconstexpr
Initial value:
=
2
The documentation for this class was generated from the following file: