Struct js_sys::Number

#[repr(transparent)]
pub struct Number { /* private fields */ }

Implementations

impl Number

pub fn is_finite(value: &JsValue) -> bool

The Number.isFinite() method determines whether the passed value is a finite number.

MDN documentation

impl Number

pub fn is_integer(value: &JsValue) -> bool

The Number.isInteger() method determines whether the passed value is an integer.

MDN documentation

impl Number

pub fn is_nan(value: &JsValue) -> bool

The Number.isNaN() method determines whether the passed value is NaN and its type is Number. It is a more robust version of the original, global isNaN().

MDN documentation

impl Number

pub fn is_safe_integer(value: &JsValue) -> bool

The Number.isSafeInteger() method determines whether the provided value is a number that is a safe integer.

MDN documentation

impl Number

pub fn new(value: &JsValue) -> Number

👎 Deprecated:

recommended to use Number::from instead

The Number JavaScript object is a wrapper object allowing you to work with numerical values. A Number object is created using the Number() constructor.

MDN documentation

impl Number

pub fn parse_int(text: &str, radix: u8) -> f64

The Number.parseInt() method parses a string argument and returns an integer of the specified radix or base.

MDN documentation

impl Number

pub fn parse_float(text: &str) -> f64

The Number.parseFloat() method parses a string argument and returns a floating point number.

MDN documentation

impl Number

pub fn to_locale_string(&self, locale: &str) -> JsString

The toLocaleString() method returns a string with a language sensitive representation of this number.

MDN documentation

impl Number

pub fn to_precision(&self, precision: u8) -> Result<JsString, JsValue>

The toPrecision() method returns a string representing the Number object to the specified precision.

MDN documentation

impl Number

pub fn to_fixed(&self, digits: u8) -> Result<JsString, JsValue>

The toFixed() method returns a string representing the Number object using fixed-point notation.

MDN documentation

impl Number

pub fn to_exponential(&self, fraction_digits: u8) -> Result<JsString, JsValue>

The toExponential() method returns a string representing the Number object in exponential notation.

MDN documentation

impl Number

pub fn to_string(&self, radix: u8) -> Result<JsString, JsValue>

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

MDN documentation

impl Number

pub fn value_of(&self) -> f64

The valueOf() method returns the wrapped primitive value of a Number object.

MDN documentation

impl Number

pub const EPSILON: f64

The smallest interval between two representable numbers.

MDN Documentation

pub const MAX_SAFE_INTEGER: f64

The maximum safe integer in JavaScript (2^53 - 1).

MDN Documentation

pub const MAX_VALUE: f64

The largest positive representable number.

MDN Documentation

pub const MIN_SAFE_INTEGER: f64

The minimum safe integer in JavaScript (-(2^53 - 1)).

MDN Documentation

pub const MIN_VALUE: f64

The smallest positive representable number—that is, the positive number closest to zero (without actually being zero).

MDN Documentation

pub const NAN: f64

Special “Not a Number” value.

MDN Documentation

pub const NEGATIVE_INFINITY: f64

Special value representing negative infinity. Returned on overflow.

MDN Documentation

pub const POSITIVE_INFINITY: f64

Special value representing infinity. Returned on overflow.

MDN Documentation

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

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

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

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

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

MDN documentation

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

pub fn to_string(&self) -> JsString

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

MDN documentation

pub fn value_of(&self) -> Object

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

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

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.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS 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.

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.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

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

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

Trait Implementations

impl AsRef<JsValue> for Number

fn as_ref(&self) -> &JsValue

Performs the conversion.

impl AsRef<Number> for Number

fn as_ref(&self) -> &Number

Performs the conversion.

impl AsRef<Object> for Number

fn as_ref(&self) -> &Object

Performs the conversion.

impl Clone for Number

fn clone(&self) -> Number

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Number

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

Formats the value using the given formatter.

impl Default for Number

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Number

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl From<JsValue> for Number

fn from(obj: JsValue) -> Number

Performs the conversion.

impl From<Number> for JsValue

fn from(obj: Number) -> JsValue

Performs the conversion.

impl From<Number> for Object

fn from(obj: Number) -> Object

Performs the conversion.

impl From<Number> for f64

fn from(n: Number) -> f64

Performs the conversion.

impl From<f32> for Number

fn from(x: f32) -> Number

Performs the conversion.

impl From<f64> for Number

fn from(x: f64) -> Number

Performs the conversion.

impl From<i16> for Number

fn from(x: i16) -> Number

Performs the conversion.

impl From<i32> for Number

fn from(x: i32) -> Number

Performs the conversion.

impl From<i8> for Number

fn from(x: i8) -> Number

Performs the conversion.

impl From<u16> for Number

fn from(x: u16) -> Number

Performs the conversion.

impl From<u32> for Number

fn from(x: u32) -> Number

Performs the conversion.

impl From<u8> for Number

fn from(x: u8) -> Number

Performs the conversion.

impl FromWasmAbi for Number

type Abi = <JsValue as FromWasmAbi>::Abi

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

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

Recover a Self from Self::Abi.

impl IntoWasmAbi for Number

type Abi = <JsValue as IntoWasmAbi>::Abi

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

fn into_abi(self) -> Self::Abi

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

impl<'a> IntoWasmAbi for &'a Number

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

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

fn into_abi(self) -> Self::Abi

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

impl JsCast for Number

fn instanceof(val: &JsValue) -> bool

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

fn is_type_of(val: &JsValue) -> bool

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

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

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

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

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

Test whether this JS value has a type T.

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.

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.

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

Performs a zero-cost unchecked cast into the specified type.

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

Performs a zero-cost unchecked cast into a reference to the specified type.

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

Test whether this JS value is an instance of the type T.

impl OptionFromWasmAbi for Number

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.

impl OptionIntoWasmAbi for Number

fn none() -> Self::Abi

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

impl<'a> OptionIntoWasmAbi for &'a Number

fn none() -> Self::Abi

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

impl PartialEq<f32> for Number

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<f64> for Number

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<i16> for Number

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<i32> for Number

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<i8> for Number

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<u16> for Number

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<u32> for Number

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<u8> for Number

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl RefFromWasmAbi for Number

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Number>

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.

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

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for Number

fn describe()