pub struct Uint8ClampedArray { /* private fields */ }
Implementations§
source§impl Uint8ClampedArray
impl Uint8ClampedArray
sourcepub fn new(constructor_arg: &JsValue) -> Uint8ClampedArray
pub fn new(constructor_arg: &JsValue) -> Uint8ClampedArray
The
Uint8ClampedArray()
constructor creates a new array.
source§impl Uint8ClampedArray
impl Uint8ClampedArray
sourcepub fn new_with_length(length: u32) -> Uint8ClampedArray
pub fn new_with_length(length: u32) -> Uint8ClampedArray
An
Uint8ClampedArray()
which creates an array with an internal buffer large
enough for length
elements.
source§impl Uint8ClampedArray
impl Uint8ClampedArray
sourcepub fn new_with_byte_offset(
buffer: &JsValue,
byte_offset: u32,
) -> Uint8ClampedArray
pub fn new_with_byte_offset( buffer: &JsValue, byte_offset: u32, ) -> Uint8ClampedArray
An
Uint8ClampedArray()
which creates an array with the given buffer but is a
view starting at byte_offset
.
source§impl Uint8ClampedArray
impl Uint8ClampedArray
sourcepub fn new_with_byte_offset_and_length(
buffer: &JsValue,
byte_offset: u32,
length: u32,
) -> Uint8ClampedArray
pub fn new_with_byte_offset_and_length( buffer: &JsValue, byte_offset: u32, length: u32, ) -> Uint8ClampedArray
An
Uint8ClampedArray()
which creates an array with the given buffer but is a
view starting at byte_offset
for length
elements.
source§impl Uint8ClampedArray
impl Uint8ClampedArray
source§impl Uint8ClampedArray
impl Uint8ClampedArray
sourcepub fn buffer(&self) -> ArrayBuffer
pub fn buffer(&self) -> ArrayBuffer
The buffer accessor property represents the ArrayBuffer
referenced
by a TypedArray
at construction time.
source§impl Uint8ClampedArray
impl Uint8ClampedArray
sourcepub fn subarray(&self, begin: u32, end: u32) -> Uint8ClampedArray
pub fn subarray(&self, begin: u32, end: u32) -> Uint8ClampedArray
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 Uint8ClampedArray
impl Uint8ClampedArray
sourcepub fn slice(&self, begin: u32, end: u32) -> Uint8ClampedArray
pub fn slice(&self, begin: u32, end: u32) -> Uint8ClampedArray
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 Uint8ClampedArray
impl Uint8ClampedArray
sourcepub fn byte_length(&self) -> u32
pub fn byte_length(&self) -> u32
The byteLength accessor property represents the length (in bytes) of a typed array.
source§impl Uint8ClampedArray
impl Uint8ClampedArray
sourcepub fn byte_offset(&self) -> u32
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 Uint8ClampedArray
impl Uint8ClampedArray
sourcepub fn copy_within(
&self,
target: i32,
start: i32,
end: i32,
) -> Uint8ClampedArray
pub fn copy_within( &self, target: i32, start: i32, end: i32, ) -> Uint8ClampedArray
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.
source§impl Uint8ClampedArray
impl Uint8ClampedArray
sourcepub unsafe fn view(rust: &[u8]) -> Uint8ClampedArray
pub unsafe fn view(rust: &[u8]) -> Uint8ClampedArray
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.
sourcepub unsafe fn view_mut_raw(ptr: *mut u8, length: usize) -> Uint8ClampedArray
pub unsafe fn view_mut_raw(ptr: *mut u8, length: usize) -> Uint8ClampedArray
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.
sourcepub unsafe fn raw_copy_to_ptr(&self, dst: *mut u8)
pub unsafe fn raw_copy_to_ptr(&self, dst: *mut u8)
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.
sourcepub fn copy_to(&self, dst: &mut [u8])
pub fn copy_to(&self, dst: &mut [u8])
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.
sourcepub fn copy_from(&self, src: &[u8])
pub fn copy_from(&self, src: &[u8])
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.
Methods from Deref<Target = Object>§
sourcepub fn constructor(&self) -> Function
pub fn constructor(&self) -> Function
The constructor property returns a reference to the Object
constructor
function that created the instance object.
sourcepub fn has_own_property(&self, property: &JsValue) -> bool
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).
sourcepub fn is_prototype_of(&self, value: &JsValue) -> bool
pub fn is_prototype_of(&self, value: &JsValue) -> bool
The isPrototypeOf()
method checks if an object exists in another
object’s prototype chain.
sourcepub fn property_is_enumerable(&self, property: &JsValue) -> bool
pub fn property_is_enumerable(&self, property: &JsValue) -> bool
The propertyIsEnumerable()
method returns a Boolean indicating
whether the specified property is enumerable.
sourcepub fn to_locale_string(&self) -> JsString
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.
sourcepub fn to_string(&self) -> JsString
pub fn to_string(&self) -> JsString
The toString()
method returns a string representing the object.
Methods from Deref<Target = JsValue>§
pub const NULL: JsValue = _
pub const UNDEFINED: JsValue = _
pub const TRUE: JsValue = _
pub const FALSE: JsValue = _
sourcepub fn as_f64(&self) -> Option<f64>
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
.
sourcepub fn as_string(&self) -> Option<String>
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.
sourcepub fn as_bool(&self) -> Option<bool>
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
.
sourcepub fn is_undefined(&self) -> bool
pub fn is_undefined(&self) -> bool
Tests whether this JS value is undefined
sourcepub fn is_function(&self) -> bool
pub fn is_function(&self) -> bool
Tests whether the type of this JS value is function
.
sourcepub fn js_in(&self, obj: &JsValue) -> bool
pub fn js_in(&self, obj: &JsValue) -> bool
Applies the binary in
JS operator on the two JsValue
s.
sourcepub fn loose_eq(&self, other: &JsValue) -> bool
pub fn loose_eq(&self, other: &JsValue) -> bool
Compare two JsValue
s for equality, using the ==
operator in JS.
sourcepub fn unsigned_shr(&self, rhs: &JsValue) -> u32
pub fn unsigned_shr(&self, rhs: &JsValue) -> u32
Applies the binary >>>
JS operator on the two JsValue
s.
sourcepub fn checked_div(&self, rhs: &JsValue) -> JsValue
pub fn checked_div(&self, rhs: &JsValue) -> JsValue
Applies the binary /
JS operator on two JsValue
s, catching and returning any RangeError
thrown.
sourcepub fn pow(&self, rhs: &JsValue) -> JsValue
pub fn pow(&self, rhs: &JsValue) -> JsValue
Applies the binary **
JS operator on the two JsValue
s.
sourcepub fn lt(&self, other: &JsValue) -> bool
pub fn lt(&self, other: &JsValue) -> bool
Applies the binary <
JS operator on the two JsValue
s.
sourcepub fn le(&self, other: &JsValue) -> bool
pub fn le(&self, other: &JsValue) -> bool
Applies the binary <=
JS operator on the two JsValue
s.
sourcepub fn ge(&self, other: &JsValue) -> bool
pub fn ge(&self, other: &JsValue) -> bool
Applies the binary >=
JS operator on the two JsValue
s.
sourcepub fn gt(&self, other: &JsValue) -> bool
pub fn gt(&self, other: &JsValue) -> bool
Applies the binary >
JS operator on the two JsValue
s.
sourcepub fn unchecked_into_f64(&self) -> f64
pub fn unchecked_into_f64(&self) -> f64
Applies the unary +
JS operator on a JsValue
. Can throw.
Trait Implementations§
source§impl AsRef<JsValue> for Uint8ClampedArray
impl AsRef<JsValue> for Uint8ClampedArray
source§impl AsRef<Object> for Uint8ClampedArray
impl AsRef<Object> for Uint8ClampedArray
source§impl AsRef<Uint8ClampedArray> for Uint8ClampedArray
impl AsRef<Uint8ClampedArray> for Uint8ClampedArray
source§fn as_ref(&self) -> &Uint8ClampedArray
fn as_ref(&self) -> &Uint8ClampedArray
source§impl Clone for Uint8ClampedArray
impl Clone for Uint8ClampedArray
source§fn clone(&self) -> Uint8ClampedArray
fn clone(&self) -> Uint8ClampedArray
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for Uint8ClampedArray
impl Debug for Uint8ClampedArray
source§impl Default for Uint8ClampedArray
impl Default for Uint8ClampedArray
source§fn default() -> Uint8ClampedArray
fn default() -> Uint8ClampedArray
source§impl Deref for Uint8ClampedArray
impl Deref for Uint8ClampedArray
source§impl<'a> From<&'a [u8]> for Uint8ClampedArray
impl<'a> From<&'a [u8]> for Uint8ClampedArray
source§fn from(slice: &'a [u8]) -> Uint8ClampedArray
fn from(slice: &'a [u8]) -> Uint8ClampedArray
source§impl From<JsValue> for Uint8ClampedArray
impl From<JsValue> for Uint8ClampedArray
source§fn from(obj: JsValue) -> Uint8ClampedArray
fn from(obj: JsValue) -> Uint8ClampedArray
source§impl From<Uint8ClampedArray> for JsValue
impl From<Uint8ClampedArray> for JsValue
source§fn from(obj: Uint8ClampedArray) -> JsValue
fn from(obj: Uint8ClampedArray) -> JsValue
source§impl From<Uint8ClampedArray> for Object
impl From<Uint8ClampedArray> for Object
source§fn from(obj: Uint8ClampedArray) -> Object
fn from(obj: Uint8ClampedArray) -> Object
source§impl FromWasmAbi for Uint8ClampedArray
impl FromWasmAbi for Uint8ClampedArray
source§type Abi = <JsValue as FromWasmAbi>::Abi
type Abi = <JsValue as FromWasmAbi>::Abi
source§unsafe fn from_abi(
js: <Uint8ClampedArray as FromWasmAbi>::Abi,
) -> Uint8ClampedArray
unsafe fn from_abi( js: <Uint8ClampedArray as FromWasmAbi>::Abi, ) -> Uint8ClampedArray
source§impl<'a> IntoWasmAbi for &'a Uint8ClampedArray
impl<'a> IntoWasmAbi for &'a Uint8ClampedArray
source§type Abi = <&'a JsValue as IntoWasmAbi>::Abi
type Abi = <&'a JsValue as IntoWasmAbi>::Abi
source§fn into_abi(self) -> <&'a Uint8ClampedArray as IntoWasmAbi>::Abi
fn into_abi(self) -> <&'a Uint8ClampedArray as IntoWasmAbi>::Abi
self
into Self::Abi
so that it can be sent across the wasm
ABI boundary.source§impl IntoWasmAbi for Uint8ClampedArray
impl IntoWasmAbi for Uint8ClampedArray
source§type Abi = <JsValue as IntoWasmAbi>::Abi
type Abi = <JsValue as IntoWasmAbi>::Abi
source§fn into_abi(self) -> <Uint8ClampedArray as IntoWasmAbi>::Abi
fn into_abi(self) -> <Uint8ClampedArray as IntoWasmAbi>::Abi
self
into Self::Abi
so that it can be sent across the wasm
ABI boundary.source§impl JsCast for Uint8ClampedArray
impl JsCast for Uint8ClampedArray
source§fn instanceof(val: &JsValue) -> bool
fn instanceof(val: &JsValue) -> bool
instanceof
check to see whether the JsValue
provided is an instance of this type. Read moresource§fn unchecked_from_js(val: JsValue) -> Uint8ClampedArray
fn unchecked_from_js(val: JsValue) -> Uint8ClampedArray
source§fn unchecked_from_js_ref(val: &JsValue) -> &Uint8ClampedArray
fn unchecked_from_js_ref(val: &JsValue) -> &Uint8ClampedArray
source§fn has_type<T>(&self) -> boolwhere
T: JsCast,
fn has_type<T>(&self) -> boolwhere
T: JsCast,
T
. Read moresource§fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
T
. Read moresource§fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
T
. Read moresource§fn unchecked_into<T>(self) -> Twhere
T: JsCast,
fn unchecked_into<T>(self) -> Twhere
T: JsCast,
source§fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
source§impl LongRefFromWasmAbi for Uint8ClampedArray
impl LongRefFromWasmAbi for Uint8ClampedArray
source§type Anchor = Uint8ClampedArray
type Anchor = Uint8ClampedArray
RefFromWasmAbi::Anchor
source§unsafe fn long_ref_from_abi(
js: <Uint8ClampedArray as LongRefFromWasmAbi>::Abi,
) -> <Uint8ClampedArray as LongRefFromWasmAbi>::Anchor
unsafe fn long_ref_from_abi( js: <Uint8ClampedArray as LongRefFromWasmAbi>::Abi, ) -> <Uint8ClampedArray as LongRefFromWasmAbi>::Anchor
RefFromWasmAbi::ref_from_abi
source§impl OptionFromWasmAbi for Uint8ClampedArray
impl OptionFromWasmAbi for Uint8ClampedArray
source§fn is_none(abi: &<Uint8ClampedArray as FromWasmAbi>::Abi) -> bool
fn is_none(abi: &<Uint8ClampedArray as FromWasmAbi>::Abi) -> bool
None
, and otherwise it will be passed to
FromWasmAbi
.source§impl<'a> OptionIntoWasmAbi for &'a Uint8ClampedArray
impl<'a> OptionIntoWasmAbi for &'a Uint8ClampedArray
source§fn none() -> <&'a Uint8ClampedArray as IntoWasmAbi>::Abi
fn none() -> <&'a Uint8ClampedArray as IntoWasmAbi>::Abi
None
branch of this option. Read moresource§impl OptionIntoWasmAbi for Uint8ClampedArray
impl OptionIntoWasmAbi for Uint8ClampedArray
source§fn none() -> <Uint8ClampedArray as IntoWasmAbi>::Abi
fn none() -> <Uint8ClampedArray as IntoWasmAbi>::Abi
None
branch of this option. Read moresource§impl RefFromWasmAbi for Uint8ClampedArray
impl RefFromWasmAbi for Uint8ClampedArray
source§type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
Self
are recovered from.source§type Anchor = ManuallyDrop<Uint8ClampedArray>
type Anchor = ManuallyDrop<Uint8ClampedArray>
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: <Uint8ClampedArray as RefFromWasmAbi>::Abi,
) -> <Uint8ClampedArray as RefFromWasmAbi>::Anchor
unsafe fn ref_from_abi( js: <Uint8ClampedArray as RefFromWasmAbi>::Abi, ) -> <Uint8ClampedArray as RefFromWasmAbi>::Anchor
Auto Trait Implementations§
impl Freeze for Uint8ClampedArray
impl RefUnwindSafe for Uint8ClampedArray
impl !Send for Uint8ClampedArray
impl !Sync for Uint8ClampedArray
impl Unpin for Uint8ClampedArray
impl UnwindSafe for Uint8ClampedArray
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
source§type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
IntoWasmAbi::Abi
source§fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
.