sycamore::web::js_sys

Struct DataView

source
pub struct DataView { /* private fields */ }

Implementations§

source§

impl DataView

source

pub fn new( buffer: &ArrayBuffer, byteOffset: usize, byteLength: usize, ) -> DataView

The DataView view provides a low-level interface for reading and writing multiple number types in an ArrayBuffer irrespective of the platform’s endianness.

MDN documentation

source§

impl DataView

source

pub fn new_with_shared_array_buffer( buffer: &SharedArrayBuffer, byteOffset: usize, byteLength: usize, ) -> DataView

The DataView view provides a low-level interface for reading and writing multiple number types in an ArrayBuffer irrespective of the platform’s endianness.

MDN documentation

source§

impl DataView

source

pub fn buffer(&self) -> ArrayBuffer

The ArrayBuffer referenced by this view. Fixed at construction time and thus read only.

MDN documentation

source§

impl DataView

source

pub fn byte_length(&self) -> usize

The length (in bytes) of this view from the start of its ArrayBuffer. Fixed at construction time and thus read only.

MDN documentation

source§

impl DataView

source

pub fn byte_offset(&self) -> usize

The offset (in bytes) of this view from the start of its ArrayBuffer. Fixed at construction time and thus read only.

MDN documentation

source§

impl DataView

source

pub fn get_int8(&self, byte_offset: usize) -> i8

The getInt8() method gets a signed 8-bit integer (byte) at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn get_uint8(&self, byte_offset: usize) -> u8

The getUint8() method gets a unsigned 8-bit integer (byte) at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn get_int16(&self, byte_offset: usize) -> i16

The getInt16() method gets a signed 16-bit integer (short) at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn get_int16_endian(&self, byte_offset: usize, little_endian: bool) -> i16

The getInt16() method gets a signed 16-bit integer (short) at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn get_uint16(&self, byte_offset: usize) -> u16

The getUint16() method gets an unsigned 16-bit integer (unsigned short) at the specified byte offset from the start of the view.

MDN documentation

source§

impl DataView

source

pub fn get_uint16_endian(&self, byte_offset: usize, little_endian: bool) -> u16

The getUint16() method gets an unsigned 16-bit integer (unsigned short) at the specified byte offset from the start of the view.

MDN documentation

source§

impl DataView

source

pub fn get_int32(&self, byte_offset: usize) -> i32

The getInt32() method gets a signed 32-bit integer (long) at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn get_int32_endian(&self, byte_offset: usize, little_endian: bool) -> i32

The getInt32() method gets a signed 32-bit integer (long) at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn get_uint32(&self, byte_offset: usize) -> u32

The getUint32() method gets an unsigned 32-bit integer (unsigned long) at the specified byte offset from the start of the view.

MDN documentation

source§

impl DataView

source

pub fn get_uint32_endian(&self, byte_offset: usize, little_endian: bool) -> u32

The getUint32() method gets an unsigned 32-bit integer (unsigned long) at the specified byte offset from the start of the view.

MDN documentation

source§

impl DataView

source

pub fn get_float32(&self, byte_offset: usize) -> f32

The getFloat32() method gets a signed 32-bit float (float) at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn get_float32_endian(&self, byte_offset: usize, little_endian: bool) -> f32

The getFloat32() method gets a signed 32-bit float (float) at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn get_float64(&self, byte_offset: usize) -> f64

The getFloat64() method gets a signed 64-bit float (double) at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn get_float64_endian(&self, byte_offset: usize, little_endian: bool) -> f64

The getFloat64() method gets a signed 64-bit float (double) at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn set_int8(&self, byte_offset: usize, value: i8)

The setInt8() method stores a signed 8-bit integer (byte) value at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn set_uint8(&self, byte_offset: usize, value: u8)

The setUint8() method stores an unsigned 8-bit integer (byte) value at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn set_int16(&self, byte_offset: usize, value: i16)

The setInt16() method stores a signed 16-bit integer (short) value at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn set_int16_endian( &self, byte_offset: usize, value: i16, little_endian: bool, )

The setInt16() method stores a signed 16-bit integer (short) value at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn set_uint16(&self, byte_offset: usize, value: u16)

The setUint16() method stores an unsigned 16-bit integer (unsigned short) value at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn set_uint16_endian( &self, byte_offset: usize, value: u16, little_endian: bool, )

The setUint16() method stores an unsigned 16-bit integer (unsigned short) value at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn set_int32(&self, byte_offset: usize, value: i32)

The setInt32() method stores a signed 32-bit integer (long) value at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn set_int32_endian( &self, byte_offset: usize, value: i32, little_endian: bool, )

The setInt32() method stores a signed 32-bit integer (long) value at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn set_uint32(&self, byte_offset: usize, value: u32)

The setUint32() method stores an unsigned 32-bit integer (unsigned long) value at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn set_uint32_endian( &self, byte_offset: usize, value: u32, little_endian: bool, )

The setUint32() method stores an unsigned 32-bit integer (unsigned long) value at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn set_float32(&self, byte_offset: usize, value: f32)

The setFloat32() method stores a signed 32-bit float (float) value at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn set_float32_endian( &self, byte_offset: usize, value: f32, little_endian: bool, )

The setFloat32() method stores a signed 32-bit float (float) value at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn set_float64(&self, byte_offset: usize, value: f64)

The setFloat64() method stores a signed 64-bit float (double) value at the specified byte offset from the start of the DataView.

MDN documentation

source§

impl DataView

source

pub fn set_float64_endian( &self, byte_offset: usize, value: f64, little_endian: bool, )

The setFloat64() method stores a signed 64-bit float (double) value at the specified byte offset from the start of the DataView.

MDN documentation

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<DataView> for DataView

source§

fn as_ref(&self) -> &DataView

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

impl AsRef<JsValue> for DataView

source§

fn as_ref(&self) -> &JsValue

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

impl AsRef<Object> for DataView

source§

fn as_ref(&self) -> &Object

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

impl Clone for DataView

source§

fn clone(&self) -> DataView

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 DataView

source§

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

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

impl Deref for DataView

source§

type Target = Object

The resulting type after dereferencing.
source§

fn deref(&self) -> &Object

Dereferences the value.
source§

impl From<DataView> for JsValue

source§

fn from(obj: DataView) -> JsValue

Converts to this type from the input type.
source§

impl From<DataView> for Object

source§

fn from(obj: DataView) -> Object

Converts to this type from the input type.
source§

impl From<JsValue> for DataView

source§

fn from(obj: JsValue) -> DataView

Converts to this type from the input type.
source§

impl FromWasmAbi for DataView

source§

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: <DataView as FromWasmAbi>::Abi) -> DataView

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

impl<'a> IntoWasmAbi for &'a DataView

source§

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) -> <&'a DataView as IntoWasmAbi>::Abi

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

impl IntoWasmAbi for DataView

source§

type Abi = <JsValue as IntoWasmAbi>::Abi

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

fn into_abi(self) -> <DataView as IntoWasmAbi>::Abi

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

impl JsCast for DataView

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) -> DataView

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

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

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 DataView

source§

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi
source§

type Anchor = DataView

Same as RefFromWasmAbi::Anchor
source§

unsafe fn long_ref_from_abi( js: <DataView as LongRefFromWasmAbi>::Abi, ) -> <DataView as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi
source§

impl OptionFromWasmAbi for DataView

source§

fn is_none(abi: &<DataView as FromWasmAbi>::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 DataView

source§

fn none() -> <&'a DataView as IntoWasmAbi>::Abi

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

impl OptionIntoWasmAbi for DataView

source§

fn none() -> <DataView as IntoWasmAbi>::Abi

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

impl PartialEq for DataView

source§

fn eq(&self, other: &DataView) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl RefFromWasmAbi for DataView

source§

type Abi = <JsValue as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.
source§

type Anchor = ManuallyDrop<DataView>

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: <DataView as RefFromWasmAbi>::Abi, ) -> <DataView as RefFromWasmAbi>::Anchor

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

impl Eq for DataView

source§

impl StructuralPartialEq for DataView

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> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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,

source§

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,

source§

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>,

source§

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>,

source§

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,