Struct BigInt 

pub struct BigInt {
    pub negative: bool,
    pub magnitude: Vec<u8>,
}

An integer of arbitrary size.

This is a well-known extension type (see ext) for integers that do not fit into 128 bits. It holds the sign and the magnitude as big-endian bytes. Leading zero bytes are permitted, zero is never negative.

The fallback is the decimal representation as string. Integers that fit into 64 or 128 bits are not represented as BigInt: they are passed through deser as U64, I64, u128 or i128 instead. That is what the num-bigint support does. When deserializing, all of these as well as strings are accepted.

use deser::ext::BigInt;

let value: BigInt =
    "-340282366920938463463374607431768211456".parse().unwrap();
assert!(value.negative);
assert_eq!(
    value.magnitude,
    [1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
);
assert_eq!(value.to_string(), "-340282366920938463463374607431768211456");

Values are compared and hashed by their numeric value.

Fields

negative: bool

true if the integer is negative.

magnitude: Vec<u8>

The magnitude as big-endian bytes.

Implementations

impl BigInt

pub fn from_i128(value: i128) -> BigInt

Creates a big integer from an i128.

pub fn from_u128(value: u128) -> BigInt

Creates a big integer from an u128.

pub fn significant_magnitude(&self) -> &[u8]

Returns the magnitude without leading zero bytes.

pub fn is_zero(&self) -> bool

Returns true if the value is zero.

pub fn is_negative(&self) -> bool

Returns true if the value is negative (and not zero).

pub fn to_u128(&self) -> Option<u128>

Returns the value as u128 if it fits.

pub fn to_i128(&self) -> Option<i128>

Returns the value as i128 if it fits.

pub fn into_atom(self) -> Atom<'static>

Converts the value into the smallest atom that can hold it.

This is U64 or I64 if the value fits into 64 bits, an u128 or i128 extension value if it fits into 128 bits and a BigInt extension value otherwise.

Trait Implementations

impl Clone for BigInt

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BigInt

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

Formats the value using the given formatter.

impl Default for BigInt

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BigInt

fn deserialize_into<'out>( out: &'out mut Option<Self>, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that deserializes the value into the given slot.

fn initial_value() -> Option<Self>

Provides the value of a missing struct field.

fn deserialize_update<'out>( value: &'out mut Self, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that updates an existing value.

impl Display for BigInt

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

Formats the value using the given formatter.

impl Eq for BigInt

impl Extension for BigInt

fn name(&self) -> &str

Returns the human readable name of the extension type.

fn fallback(&self) -> Atom<'_>

Lowers the value into the core data model.

impl From<BigInt> for Decimal

fn from(value: BigInt) -> Decimal

Converts to this type from the input type.

impl From<i64> for BigInt

fn from(value: i64) -> BigInt

Converts to this type from the input type.

impl From<i128> for BigInt

fn from(value: i128) -> BigInt

Converts to this type from the input type.

impl From<u64> for BigInt

fn from(value: u64) -> BigInt

Converts to this type from the input type.

impl From<u128> for BigInt

fn from(value: u128) -> BigInt

Converts to this type from the input type.

impl FromStr for BigInt

fn from_str(s: &str) -> Result<BigInt, Error>

Parses a decimal integer with an optional sign.

type Err = Error

The associated error which can be returned from parsing.

impl Hash for BigInt

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 BigInt

fn cmp(&self, other: &BigInt) -> 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,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for BigInt

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for BigInt

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for BigInt

fn serialize(&self, _state: &mut State) -> Result<Chunk<'_>, Error>

Serializes this serializable.

fn finish(&self, _state: &mut State) -> Result<(), Error>

Invoked after the serialization finished.

fn is_optional(&self) -> bool

Checks if the current value that would be serialized represents an optional value.

fn describe(&self, d: &mut dyn Describe)

Describes the Rust shape of this value.

fn container_shape(&self) -> ContainerShape

Returns the shape of this value if it’s a map or sequence.