Struct rusty_v8_m::ArrayBuffer

#[repr(C)]pub struct ArrayBuffer(_);

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

Methods

impl ArrayBuffer

pub fn new<'sc>(
    scope: &mut impl ToLocal<'sc>,
    byte_length: usize
) -> Local<'sc, ArrayBuffer>

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.

pub fn with_backing_store<'sc>(
    scope: &mut impl ToLocal<'sc>,
    backing_store: &SharedRef<BackingStore>
) -> Local<'sc, ArrayBuffer>

pub fn byte_length(&self) -> usize

Data length in bytes.

pub fn get_backing_store(&self) -> SharedRef<BackingStore>

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.

pub fn new_backing_store(
    scope: &mut impl InIsolate,
    byte_length: usize
) -> UniqueRef<BackingStore>

Returns a new standalone BackingStore that is allocated using the array buffer allocator of the isolate. 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.

pub fn new_backing_store_from_boxed_slice(
    data: Box<[u8]>
) -> UniqueRef<BackingStore>

Returns a new standalone BackingStore that takes over the ownership of the given buffer.

The destructor of the BackingStore frees owned buffer memory.

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.

Methods from Deref<Target = Object>

pub fn set(
    &self,
    context: Local<Context>,
    key: Local<Value>,
    value: Local<Value>
) -> Option<bool>

Set only return Just(true) or Empty(), so if it should never fail, use result.Check().

pub fn set_index(
    &self,
    context: Local<Context>,
    index: u32,
    value: Local<Value>
) -> Option<bool>

Set only return Just(true) or Empty(), so if it should never fail, use result.Check().

pub fn get_property_names<'a>(
    &self,
    scope: &mut impl ToLocal<'a>,
    context: Local<Context>
) -> Local<'a, Array>

pub fn set_prototype(
    &self,
    context: Local<Context>,
    prototype: Local<Value>
) -> Option<bool>

Set the prototype object. This does not skip objects marked to be skipped by proto and it does not consult the security handler.

pub fn create_data_property(
    &self,
    context: Local<Context>,
    key: Local<Name>,
    value: Local<Value>
) -> Option<bool>

Implements CreateDataProperty (ECMA-262, 7.3.4).

Defines a configurable, writable, enumerable property with the given value on the object unless the property already exists and is not configurable or the object is not extensible.

Returns true on success.

pub fn define_own_property(
    &self,
    context: Local<Context>,
    key: Local<Name>,
    value: Local<Value>,
    attr: PropertyAttribute
) -> Option<bool>

Implements DefineOwnProperty.

In general, CreateDataProperty will be faster, however, does not allow for specifying attributes.

Returns true on success.

pub fn get<'a>(
    &self,
    scope: &mut impl ToLocal<'a>,
    context: Local<Context>,
    key: Local<Value>
) -> Option<Local<'a, Value>>

pub fn get_index<'a>(
    &self,
    scope: &mut impl ToLocal<'a>,
    context: Local<Context>,
    index: u32
) -> Option<Local<'a, Value>>

pub fn get_prototype<'a>(
    &self,
    scope: &mut impl ToLocal<'a>
) -> Option<Local<'a, Value>>

Get the prototype object. This does not skip objects marked to be skipped by proto and it does not consult the security handler.

pub fn get_identity_hash(&self) -> int

Returns the identity hash for this object. The current implementation uses a hidden property on the object to store the identity hash.

The return value will never be 0. Also, it is not guaranteed to be unique.

pub fn creation_context<'a>(
    &self,
    scope: &mut impl ToLocal<'a>
) -> Local<'a, Context>

Returns the context in which the object was created.

Trait Implementations

impl Deref for ArrayBuffer

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.