Struct ArrayBuffer 

pub struct ArrayBuffer<'ab> {
    buffer: Local<'ab, *mut JSObject>,
}

Fields

buffer: Local<'ab, *mut JSObject>

Implementations

impl<'ab> ArrayBuffer<'ab>

fn create_with( cx: &'ab Context, with: CreateWith<'_, u8>, ) -> Option<ArrayBuffer<'ab>>

pub fn new(cx: &Context, len: usize) -> Option<ArrayBuffer<'_>>

Creates a new ArrayBuffer with the given length.

pub fn copy_from_bytes( cx: &'ab Context, bytes: &[u8], ) -> Option<ArrayBuffer<'ab>>

Creates a new ArrayBuffer by copying the contents of the given slice.

pub fn from_vec(cx: &Context, bytes: Vec<u8>) -> Option<ArrayBuffer<'_>>

Creates a new ArrayBuffer by transferring ownership of the bytes to the JS runtime.

pub fn from_boxed_slice( cx: &Context, bytes: Box<[u8]>, ) -> Option<ArrayBuffer<'_>>

Creates a new ArrayBuffer by transferring ownership of the bytes to the JS runtime.

pub fn from(object: Local<'_, *mut JSObject>) -> Option<ArrayBuffer<'_>>

pub unsafe fn from_unchecked( object: Local<'_, *mut JSObject>, ) -> ArrayBuffer<'_>

pub fn data(&self) -> (*mut u8, usize, bool)

Returns a pointer and length to the contents of the ArrayBuffer.

The pointer may be invalidated if the ArrayBuffer is detached.

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub unsafe fn as_slice(&self) -> &[u8]

Returns a slice to the contents of the ArrayBuffer.

The slice may be invalidated if the ArrayBuffer is detached.

pub unsafe fn as_mut_slice(&self) -> &mut [u8]

Returns a mutable slice to the contents of the ArrayBuffer.

The slice may be invalidated if the ArrayBuffer is detached.

pub fn clone<'cx>( &self, cx: &'cx Context, offset: usize, len: usize, ) -> Option<ArrayBuffer<'cx>>

Clones an ArrayBuffer.

pub fn copy_data_to( &self, cx: &Context, to: &ArrayBuffer<'_>, from_index: usize, to_index: usize, count: usize, ) -> bool

Copies data from one ArrayBuffer to another. Returns false if the sizes do not match.

pub fn detach(&self, cx: &Context) -> bool

pub fn transfer<'cx>(&self, cx: &'cx Context) -> Result<ArrayBuffer<'cx>>

pub fn is_detached(&self) -> bool

pub fn is_shared(&self) -> bool

pub fn is_array_buffer(object: *mut JSObject) -> bool

Checks if an object is an array buffer.

Methods from Deref<Target = Local<'ab, *mut JSObject>>

pub fn handle(&self) -> Handle<'local, T>

Forms a Handle to the Local which can be passed to SpiderMonkey APIs.

pub fn handle_mut(&mut self) -> MutableHandle<'local, T>

Forms a Handle to the Local which can be passed to SpiderMonkey APIs.

Panics

Panics when a Local::Handle is passed.

pub fn get(&self) -> T

Trait Implementations

impl<'ab> Debug for ArrayBuffer<'ab>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'ab> Deref for ArrayBuffer<'ab>

type Target = Local<'ab, *mut JSObject>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for ArrayBuffer<'_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'cx> FromValue<'cx> for ArrayBuffer<'cx>

type Config = ()

fn from_value( cx: &'cx Context, value: &Value<'_>, _: bool, _: (), ) -> Result<ArrayBuffer<'cx>>

Converts value to the desired type. strict and config determine the strictness of the conversion and specify additional conversion constraints respectively. Returns Err with the error if conversion fails.

impl<'cx> ToValue<'cx> for ArrayBuffer<'cx>

fn to_value(&self, cx: &'cx Context, value: &mut Value<'_>)

Converts self to a Value and stores it in value.

fn as_value(&self, cx: &'cx Context) -> Value<'cx>

Converts self to a new Value.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes