Struct boa_engine::bigint::JsBigInt

pub struct JsBigInt { /* private fields */ }

JavaScript bigint primitive rust type.

Implementations

impl JsBigInt

pub fn new<T: Into<Self>>(value: T) -> Self

Create a new JsBigInt.

pub fn zero() -> Self

Create a JsBigInt with value 0.

pub fn is_zero(&self) -> bool

Check if is zero.

pub fn one() -> Self

Create a JsBigInt with value 1.

pub fn is_one(&self) -> bool

Check if is one.

pub fn to_string_radix(&self, radix: u32) -> String

Convert bigint to string with radix.

pub fn to_f64(&self) -> f64

Converts the BigInt to a f64 type.

Returns f64::INFINITY if the BigInt is too big.

pub fn from_string_radix(buf: &str, radix: u32) -> Option<Self>

Converts a string to a BigInt with the specified radix.

pub fn from_string(string: &str) -> Option<Self>

This function takes a string and converts it to BigInt type.

More information:

• ECMAScript reference

pub fn same_value_zero(x: &Self, y: &Self) -> bool

Checks for SameValueZero equality.

More information:

• ECMAScript reference

pub fn same_value(x: &Self, y: &Self) -> bool

Checks for SameValue equality.

More information:

• ECMAScript reference

pub fn equal(x: &Self, y: &Self) -> bool

Checks for mathematical equality.

The abstract operation BigInt::equal takes arguments x (a BigInt) and y (a BigInt). It returns true if x and y have the same mathematical integer value and false otherwise.

More information:

• ECMAScript reference

pub fn pow(x: &Self, y: &Self) -> JsResult<Self>

Returns x to the power y.

pub fn shift_right(x: &Self, y: &Self) -> JsResult<Self>

Performs the >> operation.

pub fn shift_left(x: &Self, y: &Self) -> JsResult<Self>

Performs the << operation.

pub fn mod_floor(x: &Self, y: &Self) -> Self

Floored integer modulo.

Examples

assert_eq!((8).mod_floor(&3), 2);
assert_eq!((8).mod_floor(&-3), -1);

pub fn add(x: &Self, y: &Self) -> Self

Performs the + operation.

pub fn sub(x: &Self, y: &Self) -> Self

Performs the - operation.

pub fn mul(x: &Self, y: &Self) -> Self

Performs the * operation.

pub fn div(x: &Self, y: &Self) -> Self

Performs the / operation.

pub fn rem(x: &Self, y: &Self) -> Self

Performs the % operation.

pub fn bitand(x: &Self, y: &Self) -> Self

Performs the & operation.

pub fn bitor(x: &Self, y: &Self) -> Self

Performs the | operation.

pub fn bitxor(x: &Self, y: &Self) -> Self

Performs the ^ operation.

pub fn neg(x: &Self) -> Self

Performs the unary - operation.

pub fn not(x: &Self) -> Self

Performs the unary ! operation.

Trait Implementations

impl Clone for JsBigInt

fn clone(&self) -> JsBigInt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JsBigInt

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

Formats the value using the given formatter.

impl Display for JsBigInt

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

Formats the value using the given formatter.

impl Finalize for JsBigInt

fn finalize(&self)

Cleanup logic for a type.

impl From<BigInt> for JsBigInt

fn from(value: RawBigInt) -> Self

Converts to this type from the input type.

impl From<Box<BigInt>> for JsBigInt

fn from(value: Box<RawBigInt>) -> Self

Converts to this type from the input type.

impl From<JsBigInt> for JsValue

fn from(value: JsBigInt) -> Self

Converts to this type from the input type.

impl From<JsBigInt> for Numeric

fn from(value: JsBigInt) -> Self

Converts to this type from the input type.

impl From<i128> for JsBigInt

fn from(value: i128) -> Self

Converts to this type from the input type.

impl From<i16> for JsBigInt

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for JsBigInt

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for JsBigInt

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for JsBigInt

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<isize> for JsBigInt

fn from(value: isize) -> Self

Converts to this type from the input type.

impl From<u128> for JsBigInt

fn from(value: u128) -> Self

Converts to this type from the input type.

impl From<u16> for JsBigInt

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for JsBigInt

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for JsBigInt

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for JsBigInt

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<usize> for JsBigInt

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Hash for JsBigInt

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for JsBigInt

fn cmp(&self, other: &JsBigInt) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<JsBigInt> for f64

fn eq(&self, other: &JsBigInt) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<JsBigInt> for i32

fn eq(&self, other: &JsBigInt) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<f64> for JsBigInt

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<i32> for JsBigInt

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for JsBigInt

fn eq(&self, other: &JsBigInt) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for JsBigInt

fn partial_cmp(&self, other: &JsBigInt) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Trace for JsBigInt

unsafe fn trace(&self, _tracer: &mut Tracer)

Marks all contained Gcs.

unsafe fn trace_non_roots(&self)

Trace handles located in GC heap, and mark them as non root.

fn run_finalizer(&self)

Runs Finalize::finalize on this object and all contained subobjects.

impl TryFrom<f64> for JsBigInt

type Error = TryFromF64Error

The type returned in the event of a conversion error.

fn try_from(n: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFromJs for JsBigInt

fn try_from_js(value: &JsValue, _context: &mut Context) -> JsResult<Self>

This function tries to convert a JavaScript value into Self.

impl Eq for JsBigInt

impl JsData for JsBigInt

impl StructuralPartialEq for JsBigInt