[][src]Struct js_sys::Uint8Array

#[repr(transparent)]pub struct Uint8Array { /* fields omitted */ }

Implementations

impl Uint8Array[src]

pub fn new(constructor_arg: &JsValue) -> Uint8Array[src]

The Uint8Array() constructor creates a new array.

MDN documentation

impl Uint8Array[src]

pub fn new_with_length(length: u32) -> Uint8Array[src]

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

MDN documentation

impl Uint8Array[src]

pub fn new_with_byte_offset(buffer: &JsValue, byte_offset: u32) -> Uint8Array[src]

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

MDN documentation

impl Uint8Array[src]

pub fn new_with_byte_offset_and_length(
    buffer: &JsValue,
    byte_offset: u32,
    length: u32
) -> Uint8Array
[src]

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

MDN documentation

impl Uint8Array[src]

pub fn fill(&self, value: u8, start: u32, end: u32) -> Uint8Array[src]

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

impl Uint8Array[src]

pub fn buffer(&self) -> ArrayBuffer[src]

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

impl Uint8Array[src]

pub fn subarray(&self, begin: u32, end: u32) -> Uint8Array[src]

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

impl Uint8Array[src]

pub fn slice(&self, begin: u32, end: u32) -> Uint8Array[src]

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().

impl Uint8Array[src]

pub fn for_each(&self, callback: &mut dyn FnMut(u8, u32, Uint8Array))[src]

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.

impl Uint8Array[src]

pub fn length(&self) -> u32[src]

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

impl Uint8Array[src]

pub fn byte_length(&self) -> u32[src]

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

impl Uint8Array[src]

pub fn byte_offset(&self) -> u32[src]

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

impl Uint8Array[src]

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

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

impl Uint8Array[src]

pub fn get_index(&self, idx: u32) -> u8[src]

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

impl Uint8Array[src]

pub fn set_index(&self, idx: u32, value: u8)[src]

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

impl Uint8Array[src]

pub unsafe fn view(rust: &[u8]) -> Uint8Array[src]

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.

pub unsafe fn view_mut_raw(ptr: *mut u8, length: usize) -> Uint8Array[src]

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 guranteed to be reflected in the input array.

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

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.

pub fn to_vec(&self) -> Vec<u8>[src]

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

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function[src]

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

MDN documentation

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

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

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

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

MDN documentation

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

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

MDN documentation

pub fn to_locale_string(&self) -> JsString[src]

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

pub fn to_string(&self) -> JsString[src]

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

MDN documentation

pub fn value_of(&self) -> Object[src]

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

MDN documentation

Trait Implementations

impl AsRef<JsValue> for Uint8Array[src]

impl AsRef<Object> for Uint8Array[src]

impl AsRef<Uint8Array> for Uint8Array[src]

impl Clone for Uint8Array

impl Debug for Uint8Array

impl Deref for Uint8Array[src]

type Target = Object

The resulting type after dereferencing.

impl<'a> From<&'a [u8]> for Uint8Array[src]

impl From<JsValue> for Uint8Array[src]

impl From<Uint8Array> for JsValue[src]

impl From<Uint8Array> for Object[src]

impl FromWasmAbi for Uint8Array[src]

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary. Read more

impl IntoWasmAbi for Uint8Array[src]

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary. Read more

impl<'a> IntoWasmAbi for &'a Uint8Array[src]

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

The wasm ABI type that this converts into when crossing the ABI boundary. Read more

impl JsCast for Uint8Array[src]

impl OptionFromWasmAbi for Uint8Array[src]

impl OptionIntoWasmAbi for Uint8Array[src]

impl<'a> OptionIntoWasmAbi for &'a Uint8Array[src]

impl RefFromWasmAbi for Uint8Array[src]

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Uint8Array>

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. Read more

impl WasmDescribe for Uint8Array[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ReturnWasmAbi for T where
    T: IntoWasmAbi
[src]

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.