Struct js_sys::Uint16Array

source ·
pub struct Uint16Array { /* private fields */ }
Expand description

Implementations§

source§

impl Uint16Array

source

pub fn new(constructor_arg: &JsValue) -> Uint16Array

The Uint16Array() constructor creates a new array.

MDN documentation

source§

impl Uint16Array

source

pub fn new_with_length(length: u32) -> Uint16Array

An Uint16Array() which creates an array with an internal buffer large enough for length elements.

MDN documentation

source§

impl Uint16Array

source

pub fn new_with_byte_offset(buffer: &JsValue, byte_offset: u32) -> Uint16Array

An Uint16Array() which creates an array with the given buffer but is a view starting at byte_offset.

MDN documentation

source§

impl Uint16Array

source

pub fn new_with_byte_offset_and_length( buffer: &JsValue, byte_offset: u32, length: u32 ) -> Uint16Array

An Uint16Array() which creates an array with the given buffer but is a view starting at byte_offset for length elements.

MDN documentation

source§

impl Uint16Array

source

pub fn fill(&self, value: u16, start: u32, end: u32) -> Uint16Array

The fill() method fills all the elements of an array from a start index to an end index with a static value. The end index is not included.

MDN documentation

source§

impl Uint16Array

source

pub fn buffer(&self) -> ArrayBuffer

The buffer accessor property represents the ArrayBuffer referenced by a TypedArray at construction time.

source§

impl Uint16Array

source

pub fn subarray(&self, begin: u32, end: u32) -> Uint16Array

The subarray() method returns a new TypedArray on the same ArrayBuffer store and with the same element types as for this TypedArray object.

source§

impl Uint16Array

source

pub fn slice(&self, begin: u32, end: u32) -> Uint16Array

The slice() method returns a shallow copy of a portion of a typed array into a new typed array object. This method has the same algorithm as Array.prototype.slice().

source§

impl Uint16Array

source

pub fn for_each(&self, callback: &mut dyn FnMut(u16, u32, Uint16Array))

The forEach() method executes a provided function once per array element. This method has the same algorithm as Array.prototype.forEach(). TypedArray is one of the typed array types here.

source§

impl Uint16Array

source

pub fn length(&self) -> u32

The length accessor property represents the length (in elements) of a typed array.

source§

impl Uint16Array

source

pub fn byte_length(&self) -> u32

The byteLength accessor property represents the length (in bytes) of a typed array.

source§

impl Uint16Array

source

pub fn byte_offset(&self) -> u32

The byteOffset accessor property represents the offset (in bytes) of a typed array from the start of its ArrayBuffer.

source§

impl Uint16Array

source

pub fn set(&self, src: &JsValue, offset: u32)

The set() method stores multiple values in the typed array, reading input values from a specified array.

source§

impl Uint16Array

source

pub fn at(&self, idx: i32) -> Option<u16>

Gets the value at idx, counting from the end if negative.

source§

impl Uint16Array

source

pub fn copy_within(&self, target: i32, start: i32, end: i32) -> Uint16Array

The copyWithin() method shallow copies part of a typed array to another location in the same typed array and returns it, without modifying its size.

MDN documentation

source§

impl Uint16Array

source

pub fn get_index(&self, idx: u32) -> u16

Gets the value at idx, equivalent to the javascript my_var = arr[idx].

source§

impl Uint16Array

source

pub fn set_index(&self, idx: u32, value: u16)

Sets the value at idx, equivalent to the javascript arr[idx] = value.

source§

impl Uint16Array

source

pub unsafe fn view(rust: &[u16]) -> Uint16Array

Creates a JS typed array which is a view into wasm’s linear memory at the slice specified.

This function returns a new typed array which is a view into wasm’s memory. This view does not copy the underlying data.

§Unsafety

Views into WebAssembly memory are only valid so long as the backing buffer isn’t resized in JS. Once this function is called any future calls to Box::new (or malloc of any form) may cause the returned value here to be invalidated. Use with caution!

Additionally the returned object can be safely mutated but the input slice isn’t guaranteed to be mutable.

Finally, the returned object is disconnected from the input slice’s lifetime, so there’s no guarantee that the data is read at the right time.

source

pub unsafe fn view_mut_raw(ptr: *mut u16, length: usize) -> Uint16Array

Creates a JS typed array which is a view into wasm’s linear memory at the specified pointer with specified length.

This function returns a new typed array which is a view into wasm’s memory. This view does not copy the underlying data.

§Unsafety

Views into WebAssembly memory are only valid so long as the backing buffer isn’t resized in JS. Once this function is called any future calls to Box::new (or malloc of any form) may cause the returned value here to be invalidated. Use with caution!

Additionally the returned object can be safely mutated, the changes are guaranteed to be reflected in the input array.

source

pub unsafe fn raw_copy_to_ptr(&self, dst: *mut u16)

Copy the contents of this JS typed array into the destination Rust pointer.

This function will efficiently copy the memory from a typed array into this wasm module’s own linear memory, initializing the memory destination provided.

§Unsafety

This function requires dst to point to a buffer large enough to fit this array’s contents.

source

pub fn copy_to(&self, dst: &mut [u16])

Copy the contents of this JS typed array into the destination Rust slice.

This function will efficiently copy the memory from a typed array into this wasm module’s own linear memory, initializing the memory destination provided.

§Panics

This function will panic if this typed array’s length is different than the length of the provided dst array.

source

pub fn copy_from(&self, src: &[u16])

Copy the contents of the source Rust slice into this JS typed array.

This function will efficiently copy the memory from within the wasm module’s own linear memory to this typed array.

§Panics

This function will panic if this typed array’s length is different than the length of the provided src array.

source

pub fn to_vec(&self) -> Vec<u16>

Efficiently copies the contents of this JS typed array into a new Vec.

Methods from Deref<Target = Object>§

source

pub fn constructor(&self) -> Function

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

source

pub fn has_own_property(&self, property: &JsValue) -> bool

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

source

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

source

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

source

pub fn to_locale_string(&self) -> JsString

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

source

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

source

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>§

source

pub const NULL: JsValue = _

source

pub const UNDEFINED: JsValue = _

source

pub const TRUE: JsValue = _

source

pub const FALSE: JsValue = _

source

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

source

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

source

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

§UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

source

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

source

pub fn is_null(&self) -> bool

Tests whether this JS value is null

source

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

source

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

source

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

source

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

source

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

source

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

source

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

source

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

source

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

source

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

source

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

source

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

source

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

source

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

source

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

source

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

source

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

source

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

source

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

source

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations§

source§

impl AsRef<JsValue> for Uint16Array

source§

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<Object> for Uint16Array

source§

fn as_ref(&self) -> &Object

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<Uint16Array> for Uint16Array

source§

fn as_ref(&self) -> &Uint16Array

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Clone for Uint16Array

source§

fn clone(&self) -> Uint16Array

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Uint16Array

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Uint16Array

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Deref for Uint16Array

§

type Target = Object

The resulting type after dereferencing.
source§

fn deref(&self) -> &Object

Dereferences the value.
source§

impl<'a> From<&'a [u16]> for Uint16Array

source§

fn from(slice: &'a [u16]) -> Uint16Array

Converts to this type from the input type.
source§

impl From<JsValue> for Uint16Array

source§

fn from(obj: JsValue) -> Uint16Array

Converts to this type from the input type.
source§

impl From<Uint16Array> for JsValue

source§

fn from(obj: Uint16Array) -> JsValue

Converts to this type from the input type.
source§

impl From<Uint16Array> for Object

source§

fn from(obj: Uint16Array) -> Object

Converts to this type from the input type.
source§

impl FromWasmAbi for Uint16Array

§

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary.
source§

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi. Read more
source§

impl<'a> IntoWasmAbi for &'a Uint16Array

§

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.
source§

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.
source§

impl IntoWasmAbi for Uint16Array

§

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.
source§

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.
source§

impl JsCast for Uint16Array

source§

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type. Read more
source§

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self Read more
source§

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self. Read more
source§

fn has_type<T>(&self) -> bool
where T: JsCast,

Test whether this JS value has a type T. Read more
source§

fn dyn_into<T>(self) -> Result<T, Self>
where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T. Read more
source§

fn dyn_ref<T>(&self) -> Option<&T>
where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T. Read more
source§

fn unchecked_into<T>(self) -> T
where T: JsCast,

Performs a zero-cost unchecked cast into the specified type. Read more
source§

fn unchecked_ref<T>(&self) -> &T
where T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type. Read more
source§

fn is_instance_of<T>(&self) -> bool
where T: JsCast,

Test whether this JS value is an instance of the type T. Read more
source§

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type. Read more
source§

impl LongRefFromWasmAbi for Uint16Array

§

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi
§

type Anchor = Uint16Array

Same as RefFromWasmAbi::Anchor
source§

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
source§

impl OptionFromWasmAbi for Uint16Array

source§

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.
source§

impl<'a> OptionIntoWasmAbi for &'a Uint16Array

source§

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more
source§

impl OptionIntoWasmAbi for Uint16Array

source§

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more
source§

impl RefFromWasmAbi for Uint16Array

§

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.
§

type Anchor = ManuallyDrop<Uint16Array>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.
source§

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi. Read more
source§

impl WasmDescribe for Uint16Array

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ReturnWasmAbi for T
where T: IntoWasmAbi,

§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> VectorFromWasmAbi for T
where T: JsObject,

source§

impl<T> VectorIntoWasmAbi for T
where T: JsObject,