Struct js_sys::BigInt

impl BigInt

pub fn as_int_n(bits: f64, bigint: &BigInt) -> BigInt

Clamps a BigInt value to a signed integer value, and returns that value.

impl BigInt

pub fn as_uint_n(bits: f64, bigint: &BigInt) -> BigInt

Clamps a BigInt value to an unsigned integer value, and returns that value.

impl BigInt

pub fn to_locale_string(&self, locales: &JsValue, options: &JsValue) -> JsString

Returns a string with a language-sensitive representation of this BigInt value. Overrides the Object.prototype.toLocaleString() method.

impl BigInt

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

Returns a string representing this BigInt value in the specified radix (base). Overrides the Object.prototype.toString() method.

impl BigInt

pub fn value_of(&self, radix: u8) -> BigInt

Returns this BigInt value. Overrides the Object.prototype.valueOf() method.

impl BigInt

pub fn new(value: &JsValue) -> Result<BigInt, Error>

Creates a new BigInt value.

pub fn checked_div(&self, rhs: &Self) -> Result<Self, RangeError>

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

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

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

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.

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

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

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

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.

pub fn to_string(&self) -> JsString

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

pub fn value_of(&self) -> Object

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

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.

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

Tests whether this JS value is an instance of Array.

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.

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

Applies the binary in JS operator on the two JsValues.

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.

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

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

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

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

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

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

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

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

Applies the binary < JS operator on the two JsValues.

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

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

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

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

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

Applies the binary > JS operator on the two JsValues.

pub fn unchecked_into_f64(&self) -> f64

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

Trait Implementations§

impl Add<&BigInt> for &BigInt

type Output = BigInt

The resulting type after applying the + operator.

fn add(self, other: &BigInt) -> Self::Output

Performs the + operation. Read more

impl Add<&BigInt> for BigInt

type Output = <&'static BigInt as Add<&'static BigInt>>::Output

The resulting type after applying the + operator.

fn add(self, other: &BigInt) -> Self::Output

Performs the + operation. Read more

impl<'a> Add<BigInt> for &'a BigInt

type Output = <&'static BigInt as Add<&'static BigInt>>::Output

The resulting type after applying the + operator.

fn add(self, other: BigInt) -> Self::Output

Performs the + operation. Read more

impl Add<BigInt> for BigInt

type Output = <&'static BigInt as Add<&'static BigInt>>::Output

The resulting type after applying the + operator.

fn add(self, other: BigInt) -> Self::Output

Performs the + operation. Read more

impl AsRef<BigInt> for BigInt

fn as_ref(&self) -> &BigInt

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

impl AsRef<JsValue> for BigInt

fn as_ref(&self) -> &JsValue

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

impl AsRef<Object> for BigInt

fn as_ref(&self) -> &Object

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

impl Binary for BigInt

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

Formats the value using the given formatter.

impl BitAnd<&BigInt> for &BigInt

type Output = BigInt

The resulting type after applying the & operator.

fn bitand(self, other: &BigInt) -> Self::Output

Performs the & operation. Read more

impl BitAnd<&BigInt> for BigInt

type Output = <&'static BigInt as BitAnd<&'static BigInt>>::Output

The resulting type after applying the & operator.

fn bitand(self, other: &BigInt) -> Self::Output

Performs the & operation. Read more

impl<'a> BitAnd<BigInt> for &'a BigInt

type Output = <&'static BigInt as BitAnd<&'static BigInt>>::Output

The resulting type after applying the & operator.

fn bitand(self, other: BigInt) -> Self::Output

Performs the & operation. Read more

impl BitAnd<BigInt> for BigInt

type Output = <&'static BigInt as BitAnd<&'static BigInt>>::Output

The resulting type after applying the & operator.

fn bitand(self, other: BigInt) -> Self::Output

Performs the & operation. Read more

impl BitOr<&BigInt> for &BigInt

type Output = BigInt

The resulting type after applying the | operator.

fn bitor(self, other: &BigInt) -> Self::Output

Performs the | operation. Read more

impl BitOr<&BigInt> for BigInt

type Output = <&'static BigInt as BitOr<&'static BigInt>>::Output

The resulting type after applying the | operator.

fn bitor(self, other: &BigInt) -> Self::Output

Performs the | operation. Read more

impl<'a> BitOr<BigInt> for &'a BigInt

type Output = <&'static BigInt as BitOr<&'static BigInt>>::Output

The resulting type after applying the | operator.

fn bitor(self, other: BigInt) -> Self::Output

Performs the | operation. Read more

impl BitOr<BigInt> for BigInt

type Output = <&'static BigInt as BitOr<&'static BigInt>>::Output

The resulting type after applying the | operator.

fn bitor(self, other: BigInt) -> Self::Output

Performs the | operation. Read more

impl BitXor<&BigInt> for &BigInt

type Output = BigInt

The resulting type after applying the ^ operator.

fn bitxor(self, other: &BigInt) -> Self::Output

Performs the ^ operation. Read more

impl BitXor<&BigInt> for BigInt

type Output = <&'static BigInt as BitXor<&'static BigInt>>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, other: &BigInt) -> Self::Output

Performs the ^ operation. Read more

impl<'a> BitXor<BigInt> for &'a BigInt

type Output = <&'static BigInt as BitXor<&'static BigInt>>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, other: BigInt) -> Self::Output

Performs the ^ operation. Read more

impl BitXor<BigInt> for BigInt

type Output = <&'static BigInt as BitXor<&'static BigInt>>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, other: BigInt) -> Self::Output

Performs the ^ operation. Read more

impl Clone for BigInt

fn clone(&self) -> BigInt

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

impl Debug for BigInt

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

Formats the value using the given formatter. Read more

impl Default for BigInt

fn default() -> Self

Returns the “default value” for a type. Read more

impl Deref for BigInt

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl Display for BigInt

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

Formats the value using the given formatter. Read more

impl Div<&BigInt> for &BigInt

type Output = BigInt

The resulting type after applying the / operator.

fn div(self, other: &BigInt) -> Self::Output

Performs the / operation. Read more

impl Div<&BigInt> for BigInt

type Output = <&'static BigInt as Div<&'static BigInt>>::Output

The resulting type after applying the / operator.

fn div(self, other: &BigInt) -> Self::Output

Performs the / operation. Read more

impl<'a> Div<BigInt> for &'a BigInt

type Output = <&'static BigInt as Div<&'static BigInt>>::Output

The resulting type after applying the / operator.

fn div(self, other: BigInt) -> Self::Output

Performs the / operation. Read more

impl Div<BigInt> for BigInt

type Output = <&'static BigInt as Div<&'static BigInt>>::Output

The resulting type after applying the / operator.

fn div(self, other: BigInt) -> Self::Output

Performs the / operation. Read more