Struct NatBig 

pub struct NatBig(/* private fields */);

Arbitrary-precision unsigned integer used by schema and typed values.

Candid uses its native integer type; human-readable Serde uses decimal text. Binary Serde uses native small integers and tagged little-endian wide bytes.

Implementations

impl NatBig

pub fn magnitude_bits(&self) -> u64

Return the magnitude’s bit length without allocating an encoded copy.

pub fn leb128_len(&self) -> u64

Return the exact unsigned LEB128 byte length without allocating or encoding.

pub const fn from_candid(value: WrappedNat) -> Self

Construct from the canonical Candid natural-number representation.

pub fn from_biguint(value: BigUint) -> Self

Construct from a num_bigint unsigned integer.

pub fn u32_digits( &self, ) -> impl DoubleEndedIterator<Item = u32> + ExactSizeIterator + '_

Borrow little-endian base-2^32 limbs without allocation.

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

Convert to u128 when the value is in range.

pub fn to_u64(&self) -> Option<u64>

Convert to u64 when the value is in range.

pub fn to_leb128(&self) -> Vec<u8>

Serialize this arbitrary-precision natural for internal hash and sort-key framing.

pub fn leb128_bytes(&self) -> impl Iterator<Item = u8> + '_

Iterate canonical unsigned LEB128 bytes with constant scratch and no allocation.

pub fn saturating_add(self, rhs: Self) -> Self

Saturating addition (unbounded; equivalent to normal addition).

pub fn saturating_sub(self, rhs: Self) -> Self

Saturating subtraction; clamps at zero on underflow.

Trait Implementations

impl Add for NatBig

type Output = NatBig

The resulting type after applying the + operator.

fn add(self, __rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for NatBig

fn add_assign(&mut self, __rhs: Self)

Performs the += operation.

impl CandidType for NatBig

fn _ty() -> Type

fn _ty_doc() -> TypeDoc

fn id() -> TypeId

fn idl_serialize<__S>(&self, __serializer: __S) -> Result<(), __S::Error>

where __S: Serializer,

fn ty() -> Type

impl Clone for NatBig

fn clone(&self) -> NatBig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NatBig

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

Formats the value using the given formatter.

impl Default for NatBig

fn default() -> NatBig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NatBig

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for NatBig

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

Formats the value using the given formatter.

impl Div for NatBig

type Output = NatBig

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for NatBig

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl Eq for NatBig

impl From<u32> for NatBig

fn from(n: u32) -> Self

Converts to this type from the input type.

impl From<u64> for NatBig

fn from(n: u64) -> Self

Converts to this type from the input type.

impl FromStr for NatBig

type Err = <Nat as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for NatBig

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 Mul for NatBig

type Output = NatBig

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation.

impl MulAssign for NatBig

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl NumericValue for NatBig

fn try_to_decimal(&self) -> Option<Decimal>

Convert this value into Decimal for generic numeric handling.

fn try_from_decimal(value: Decimal) -> Option<Self>

Rebuild the value from Decimal after generic numeric handling.

impl Ord for NatBig

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for NatBig

fn partial_cmp(&self, other: &NatBig) -> 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 Product for NatBig

fn product<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.

impl Serialize for NatBig

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NatBig

impl Sub for NatBig

type Output = NatBig

The resulting type after applying the - operator.

fn sub(self, __rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for NatBig

fn sub_assign(&mut self, __rhs: Self)

Performs the -= operation.

impl Sum for NatBig

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<i32> for NatBig

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.