Struct js_sys::DataView[][src]

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

Implementations

impl DataView[src]

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

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

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

impl DataView[src]

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

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

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

impl DataView[src]

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

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

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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

MDN documentation

impl DataView[src]

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

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>

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

Methods from Deref<Target = JsValue>

pub const NULL: JsValue[src]

pub const UNDEFINED: JsValue[src]

pub const TRUE: JsValue[src]

pub const FALSE: JsValue[src]

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

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.

pub fn is_string(&self) -> bool[src]

Tests whether this JS value is a JS string.

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

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.

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

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.

pub fn is_null(&self) -> bool[src]

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool[src]

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool[src]

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool[src]

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

pub fn is_function(&self) -> bool[src]

Tests whether the type of this JS value is function.

pub fn is_truthy(&self) -> bool[src]

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool[src]

Tests whether the value is “falsy”.

Trait Implementations

impl AsRef<DataView> for DataView[src]

impl AsRef<JsValue> for DataView[src]

impl AsRef<Object> for DataView[src]

impl Clone for DataView[src]

impl Debug for DataView[src]

impl Deref for DataView[src]

type Target = Object

The resulting type after dereferencing.

impl Eq for DataView[src]

impl From<DataView> for JsValue[src]

impl From<DataView> for Object[src]

impl From<JsValue> for DataView[src]

impl FromWasmAbi for DataView[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 DataView[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 DataView[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 DataView[src]

impl OptionFromWasmAbi for DataView[src]

impl OptionIntoWasmAbi for DataView[src]

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

impl PartialEq<DataView> for DataView[src]

impl RefFromWasmAbi for DataView[src]

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

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

impl StructuralEq for DataView[src]

impl StructuralPartialEq for DataView[src]

impl WasmDescribe for DataView[src]

Auto Trait Implementations

impl RefUnwindSafe for DataView

impl !Send for DataView

impl !Sync for DataView

impl Unpin for DataView

impl UnwindSafe for DataView

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.