Struct js_sys::Math

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

Implementations

impl Math

pub fn abs(x: f64) -> f64

The Math.abs() function returns the absolute value of a number, that is Math.abs(x) = |x|

MDN documentation

impl Math

pub fn acos(x: f64) -> f64

The Math.acos() function returns the arccosine (in radians) of a number, that is ∀x∊[-1;1] Math.acos(x) = arccos(x) = the unique y∊[0;π] such that cos(y)=x

MDN documentation

impl Math

pub fn acosh(x: f64) -> f64

The Math.acosh() function returns the hyperbolic arc-cosine of a number, that is ∀x ≥ 1 Math.acosh(x) = arcosh(x) = the unique y ≥ 0 such that cosh(y) = x

MDN documentation

impl Math

pub fn asin(x: f64) -> f64

The Math.asin() function returns the arcsine (in radians) of a number, that is ∀x ∊ [-1;1] Math.asin(x) = arcsin(x) = the unique y∊[-π2;π2] such that sin(y) = x

MDN documentation

impl Math

pub fn asinh(x: f64) -> f64

The Math.asinh() function returns the hyperbolic arcsine of a number, that is Math.asinh(x) = arsinh(x) = the unique y such that sinh(y) = x

MDN documentation

impl Math

pub fn atan(x: f64) -> f64

The Math.atan() function returns the arctangent (in radians) of a number, that is Math.atan(x) = arctan(x) = the unique y ∊ [-π2;π2]such that tan(y) = x

impl Math

pub fn atan2(y: f64, x: f64) -> f64

The Math.atan2() function returns the arctangent of the quotient of its arguments.

MDN documentation

impl Math

pub fn atanh(x: f64) -> f64

The Math.atanh() function returns the hyperbolic arctangent of a number, that is ∀x ∊ (-1,1), Math.atanh(x) = arctanh(x) = the unique y such that tanh(y) = x

MDN documentation

impl Math

pub fn cbrt(x: f64) -> f64

The Math.cbrt() function returns the cube root of a number, that is Math.cbrt(x) = x^3 = the unique y such that y^3 = x

MDN documentation

impl Math

pub fn ceil(x: f64) -> f64

The Math.ceil() function returns the smallest integer greater than or equal to a given number.

MDN documentation

impl Math

pub fn clz32(x: i32) -> u32

The Math.clz32() function returns the number of leading zero bits in the 32-bit binary representation of a number.

MDN documentation

impl Math

pub fn cos(x: f64) -> f64

The Math.cos() static function returns the cosine of the specified angle, which must be specified in radians. This value is length(adjacent)/length(hypotenuse).

MDN documentation

impl Math

pub fn cosh(x: f64) -> f64

The Math.cosh() function returns the hyperbolic cosine of a number, that can be expressed using the constant e.

MDN documentation

impl Math

pub fn exp(x: f64) -> f64

The Math.exp() function returns e^x, where x is the argument, and e is Euler’s number (also known as Napier’s constant), the base of the natural logarithms.

MDN documentation

impl Math

pub fn expm1(x: f64) -> f64

The Math.expm1() function returns e^x - 1, where x is the argument, and e the base of the natural logarithms.

MDN documentation

impl Math

pub fn floor(x: f64) -> f64

The Math.floor() function returns the largest integer less than or equal to a given number.

MDN documentation

impl Math

pub fn fround(x: f64) -> f32

The Math.fround() function returns the nearest 32-bit single precision float representation of a Number.

MDN documentation

impl Math

pub fn hypot(x: f64, y: f64) -> f64

The Math.hypot() function returns the square root of the sum of squares of its arguments.

MDN documentation

impl Math

pub fn imul(x: i32, y: i32) -> i32

The Math.imul() function returns the result of the C-like 32-bit multiplication of the two parameters.

MDN documentation

impl Math

pub fn log(x: f64) -> f64

The Math.log() function returns the natural logarithm (base e) of a number. The JavaScript Math.log() function is equivalent to ln(x) in mathematics.

MDN documentation

impl Math

pub fn log10(x: f64) -> f64

The Math.log10() function returns the base 10 logarithm of a number.

MDN documentation

impl Math

pub fn log1p(x: f64) -> f64

The Math.log1p() function returns the natural logarithm (base e) of 1 + a number. MDN documentation

impl Math

pub fn log2(x: f64) -> f64

The Math.log2() function returns the base 2 logarithm of a number.

MDN documentation

impl Math

pub fn max(x: f64, y: f64) -> f64

The Math.max() function returns the largest of two numbers.

MDN documentation

impl Math

pub fn min(x: f64, y: f64) -> f64

The static function Math.min() returns the lowest-valued number passed into it.

MDN documentation

impl Math

pub fn pow(base: f64, exponent: f64) -> f64

The Math.pow() function returns the base to the exponent power, that is, base^exponent.

MDN documentation

impl Math

pub fn random() -> f64

The Math.random() function returns a floating-point, pseudo-random number in the range 0–1 (inclusive of 0, but not 1) with approximately uniform distribution over that range — which you can then scale to your desired range. The implementation selects the initial seed to the random number generation algorithm; it cannot be chosen or reset by the user.

MDN documentation

impl Math

pub fn round(x: f64) -> f64

The Math.round() function returns the value of a number rounded to the nearest integer.

MDN documentation

impl Math

pub fn sign(x: f64) -> f64

The Math.sign() function returns the sign of a number, indicating whether the number is positive, negative or zero.

MDN documentation

impl Math

pub fn sin(x: f64) -> f64

The Math.sin() function returns the sine of a number.

MDN documentation

impl Math

pub fn sinh(x: f64) -> f64

The Math.sinh() function returns the hyperbolic sine of a number, that can be expressed using the constant e: Math.sinh(x) = (e^x - e^-x)/2

MDN documentation

impl Math

pub fn sqrt(x: f64) -> f64

The Math.sqrt() function returns the square root of a number, that is ∀x ≥ 0, Math.sqrt(x) = √x = the unique y ≥ 0 such that y^2 = x

MDN documentation

impl Math

pub fn tan(x: f64) -> f64

The Math.tan() function returns the tangent of a number.

MDN documentation

impl Math

pub fn tanh(x: f64) -> f64

The Math.tanh() function returns the hyperbolic tangent of a number, that is tanh x = sinh x / cosh x = (e^x - e^-x)/(e^x + e^-x) = (e^2x - 1)/(e^2x + 1)

MDN documentation

impl Math

pub fn trunc(x: f64) -> f64

The Math.trunc() function returns the integer part of a number by removing any fractional digits.

MDN documentation

Methods from Deref<Target = Object>

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 = JsValue{ idx: JSIDX_NULL, _marker: marker::PhantomData,}

pub const UNDEFINED: JsValue = JsValue{ idx: JSIDX_UNDEFINED, _marker: marker::PhantomData,}

pub const TRUE: JsValue = JsValue{ idx: JSIDX_TRUE, _marker: marker::PhantomData,}

pub const FALSE: JsValue = JsValue{ idx: JSIDX_FALSE, _marker: marker::PhantomData,}

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_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<JsValue> for Math

fn as_ref(&self) -> &JsValue

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

impl AsRef<Math> for Math

fn as_ref(&self) -> &Math

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

impl AsRef<Object> for Math

fn as_ref(&self) -> &Object

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

impl Clone for Math

fn clone(&self) -> Math

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Math

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

Formats the value using the given formatter.

impl Deref for Math

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl From<JsValue> for Math

fn from(obj: JsValue) -> Math

Converts to this type from the input type.

impl From<Math> for JsValue

fn from(obj: Math) -> JsValue

Converts to this type from the input type.

impl From<Math> for Object

fn from(obj: Math) -> Object

Converts to this type from the input type.

impl FromWasmAbi for Math

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<'a> IntoWasmAbi for &'a Math

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 IntoWasmAbi for Math

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 JsCast for Math

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance 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) -> boolwhere
    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) -> Twhere
    T: JsCast,

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

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

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

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

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

fn is_type_of(val: &JsValue) -> bool

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

impl OptionFromWasmAbi for Math

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<'a> OptionIntoWasmAbi for &'a Math

fn none() -> Self::Abi

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

impl OptionIntoWasmAbi for Math

fn none() -> Self::Abi

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

impl RefFromWasmAbi for Math

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Math>

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 Math

fn describe()