Struct script::dom::bindings::import::module::typedarray::TypedArray

pub struct TypedArray<T, S>
where
    T: TypedArrayElement,
    S: JSObjectStorage,
{
    object: S,
    computed: Cell<Option<(*mut <T as TypedArrayElement>::Element, usize)>>,
}

A typed array wrapper.

Fields

object: S

computed: Cell<Option<(*mut <T as TypedArrayElement>::Element, usize)>>

Implementations

impl<T, S> TypedArray<T, S>

where T: TypedArrayElement, S: JSObjectStorage,

pub fn from(object: *mut JSObject) -> Result<TypedArray<T, S>, ()>

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.

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) -> Vec<<T as TypedArrayElement>::Element>

where <T as TypedArrayElement>::Element: Clone,

Retrieves an owned data that’s represented by the typed array.

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

Unsafety

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

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

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.

pub fn is_shared(&self) -> bool

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

impl<T, S> TypedArray<T, S>

where T: TypedArrayElementCreator + TypedArrayElement, S: JSObjectStorage,

pub unsafe fn create( cx: *mut JSContext, with: CreateWith<'_, <T as TypedArrayElement>::Element>, result: MutableHandle<'_, *mut JSObject>, ) -> 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 as TypedArrayElement>::Element])

Update an existed JS typed array

impl<S> TypedArray<ArrayBufferViewU8, S>

where S: JSObjectStorage,

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, S> FromJSValConvertible for TypedArray<T, S>

where T: TypedArrayElement, S: JSObjectStorage,

type Config = ()

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

unsafe fn from_jsval( _cx: *mut JSContext, value: Handle<'_, Value>, _option: (), ) -> Result<ConversionResult<TypedArray<T, S>>, ()>

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, S> ToJSValConvertible for TypedArray<T, S>

where T: TypedArrayElement, S: JSObjectStorage,

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

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

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

where T: TypedArrayElement,

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

Trace self.