Struct TypedArray 

pub struct TypedArray<'bv, T: TypedArrayElement> {
    view: Local<'bv, *mut JSObject>,
    _phantom: PhantomData<T>,
}

Fields

view: Local<'bv, *mut JSObject>

_phantom: PhantomData<T>

Implementations

impl<'bv, T: TypedArrayElementCreator> TypedArray<'bv, T>

pub fn create_with( cx: &'bv Context, with: CreateWith<'_, T::Element>, ) -> Option<TypedArray<'bv, T>>

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

Creates a new TypedArray with the given length.

pub fn copy_from_bytes( cx: &'bv Context, bytes: &[T::Element], ) -> Option<TypedArray<'bv, T>>

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

pub fn from_vec( cx: &Context, bytes: Vec<T::Element>, ) -> Option<TypedArray<'_, T>>

Creates a new TypedArray by transferring ownership of the values to the JS runtime.

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

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

pub fn with_array_buffer( cx: &'bv Context, buffer: &ArrayBuffer<'_>, byte_offset: usize, len: usize, ) -> Option<TypedArray<'bv, T>>

Creates a new TypedArray with a view of the contents of an existing ArrayBuffer.

impl<'bv, T: TypedArrayElement> TypedArray<'bv, T>

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

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

pub fn data(&self) -> (*mut T::Element, usize)

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

The pointer may be invalidated if the underlying ArrayBuffer is detached.

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub unsafe fn as_slice(&self) -> &[T::Element]

Returns a slice to the contents of the TypedArray.

The slice may be invalidated if the underlying ArrayBuffer is detached.

pub unsafe fn as_mut_slice(&self) -> &mut [T::Element]

Returns a mutable slice to the contents of the TypedArray.

The slice may be invalidated if the underlying ArrayBuffer is detached.

pub fn offset(&self) -> usize

Returns the offset of the TypedArray with respect to the underlying ArrayBuffer.

pub fn byte_length(&self) -> usize

Returns the length of the TypedArray in bytes.

pub fn is_large(&self) -> bool

Checks if the TypedArray is larger than the maximum allowed on 32-bit platforms.

pub fn is_shared(&self) -> bool

Checks if the underlying ArrayBuffer is shared.

pub fn buffer<'ab>(&self, cx: &'ab Context) -> ArrayBuffer<'ab>

Returns the underlying ArrayBuffer. The buffer may be shared and/or detached.

pub fn into_local(self) -> Local<'bv, *mut JSObject>

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

Checks if an object is an array buffer view.

impl TypedArray<'_, ArrayBufferViewU8>

pub fn view_type(&self) -> Type

Methods from Deref<Target = Local<'bv, *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<T: TypedArrayElement> Debug for TypedArray<'_, T>

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

Formats the value using the given formatter.

impl<'bv, T: TypedArrayElement> Deref for TypedArray<'bv, T>

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

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: TypedArrayElement> DerefMut for TypedArray<'_, T>

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

Mutably dereferences the value.

impl<'cx, T: TypedArrayElement> FromValue<'cx> for TypedArray<'cx, T>

type Config = ()

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

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, T: TypedArrayElement> ToValue<'cx> for TypedArray<'cx, T>

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