Skip to main content

Packed

Struct Packed 

Source
pub struct Packed(/* private fields */);
Expand description

The packed integer, exactly. Most versions fit u128; a major of 2^80 or more does not, and the canonical dump writes the exact integer. Ordered, compared and hashed as Python’s int (implemented by the scaffold).

The representation is private and always canonical: a value below 2^128 is held as a u128, and a larger one as little-endian limbs with a non-zero top limb. So Packed::from_limbs of a value written with leading zero limbs (a 4,300-digit group of leading zeros, sized from its digit count) equals, hashes and orders as the same value from Packed::from_u128.

Implementations§

Source§

impl Packed

Source

pub const fn from_u128(v: u128) -> Self

The value v.

Source

pub fn from_limbs(limbs: &[u64]) -> Self

The value of little-endian u64 limbs, any number of them, leading (most significant) zero limbs included.

Source

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

The value, when it is below 2^128.

Source

pub fn big_limbs(&self) -> Option<&[u64]>

The limbs of a value of 2^128 or more, borrowed: little-endian, the last one non-zero, at most super::MAX_LIMBS for a version a parse packed. None below 2^128, where Self::as_u128 is the value. Unlike Self::to_limbs it copies nothing, so a writer of an input’s version needs no heap for it (unityrs_dump::json::write_packed).

Source

pub fn to_limbs(&self) -> Vec<u64>

The value as little-endian u64 limbs, without leading zero limbs (empty for 0).

Source

pub fn heap_bytes(&self) -> usize

The heap bytes the value owns (0 below 2^128).

Trait Implementations§

Source§

impl Clone for Packed

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Packed

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Packed

Source§

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

The exact decimal integer. Past 2^128 it costs a pass over the limbs for each 19 digits, uncounted: the dump writes a packed version with its own conversion, which counts each pass as the input’s work (unityrs_dump::json::write_packed).

Source§

impl Eq for Packed

Source§

impl Hash for Packed

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Packed

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

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. Read more
Source§

impl PartialEq for Packed

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Packed

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Packed

Auto Trait Implementations§

§

impl Forget for Packed

§

impl Freeze for Packed

§

impl Move for Packed

§

impl RefUnwindSafe for Packed

§

impl Send for Packed

§

impl Sync for Packed

§

impl Unpin for Packed

§

impl UnsafeUnpin for Packed

§

impl UnwindSafe for Packed

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.