Struct TypedArray 

pub struct TypedArray<T: TypedArrayElement, S: JSObjectStorage> {
    object: S,
    computed: Cell<ArrayData<T::Element>>,
}

A typed array wrapper.

Fields

object: S

computed: Cell<ArrayData<T::Element>>

Implementations

impl<T: TypedArrayElement, S: JSObjectStorage> TypedArray<T, S>

pub fn from(object: *mut JSObject) -> Result<Self, ()>

Create a typed array representation that wraps an existing JS reflector. This operation will fail if attempted on a JS object that does not match the expected typed array details.

fn data(&self) -> Option<NonNull<[T::Element]>>

pub fn len(&self) -> usize

Returns the number of elements in the underlying typed array.

pub unsafe fn underlying_object(&self) -> &S

Unsafety

Returned wrapped pointer to the underlying JSObject is meant to be read-only, modifying it can lead to Undefined Behaviour and violation of TypedArray API guarantees.

Practically, this exists only to implement JSTraceable trait in Servo for Box<Heap<*mut JSObject>> variant.

pub fn to_vec(&self) -> Option<Vec<T::Element>>

where T::Element: Clone,

Retrieves an owned data that’s represented by the typed array. Returns None if the underlying buffer is detached.

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

👎Deprecated: use as_slice_safe instead

Unsafety

The returned slice can be invalidated if the underlying typed array is neutered.

Panics

Panics if the underlying data points to a nullptr.

pub fn as_slice_safe<'a>(&self, _no_gc: &'a NoGC) -> Option<&'a [T::Element]>

Returns None if the underlying array buffer is detached. Otherwise, returns Some with the slice data.

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

👎Deprecated: use as_mut_slice_safe instead

Unsafety

The returned slice can be invalidated if the underlying typed array is neutered.

The underlying JSObject can be aliased, which can lead to Undefined Behavior due to mutable aliasing.

Panics

Panics if the underlying data points to a nullptr.

pub fn as_mut_slice_safe<'a>( &mut self, _no_gc: &'a NoGC, ) -> Option<&'a mut [T::Element]>

pub fn is_shared(&self) -> bool

Return a boolean flag which denotes whether the underlying buffer is a SharedArrayBuffer.

impl<T: TypedArrayElementCreator + TypedArrayElement, S: JSObjectStorage> TypedArray<T, S>

pub unsafe fn create( cx: *mut JSContext, with: CreateWith<'_, T::Element>, result: MutableHandleObject<'_>, ) -> Result<(), ()>

Create a new JS typed array, optionally providing initial data that will be copied into the newly-allocated buffer. Returns the new JS reflector.

pub fn update(&mut self, data: &[T::Element])

Update an existed JS typed array

unsafe fn update_raw(data: &[T::Element], result: *mut JSObject)

impl<S: JSObjectStorage> TypedArray<ArrayBufferViewU8, S>

pub fn get_array_type(&self) -> Type

Trait Implementations

impl<T> CustomTrace for TypedArray<T, *mut JSObject>

where T: TypedArrayElement,

fn trace(&self, trc: *mut JSTracer)

impl<T: TypedArrayElement, S: JSObjectStorage> FromJSValConvertible for TypedArray<T, S>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

fn safe_from_jsval( _cx: &mut JSContext, value: HandleValue<'_>, _option: (), ) -> Result<ConversionResult<Self>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl<T: TypedArrayElement, S: JSObjectStorage> ToJSValConvertible for TypedArray<T, S>

unsafe fn to_jsval(&self, cx: *mut JSContext, rval: MutableHandleValue<'_>)

Convert self to a JSVal. JSAPI failure causes a panic.

fn safe_to_jsval(&self, cx: &mut JSContext, rval: MutableHandleValue<'_>)

Convert self to a JSVal. JSAPI failure causes a panic.

impl<T: TypedArrayElement> Traceable for TypedArray<T, Box<Heap<*mut JSObject>>>

unsafe fn trace(&self, trc: *mut JSTracer)

Trace self.