Struct crypto_bigint::BoxedUint

pub struct BoxedUint { /* private fields */ }

Available on crate feature alloc only.

Fixed-precision heap-allocated big unsigned integer.

Alternative to the stack-allocated Uint but with a fixed precision chosen at runtime instead of compile time.

Unlike many other heap-allocated big integer libraries, this type is not arbitrary precision and will wrap at its fixed-precision rather than automatically growing.

Implementations

impl BoxedUint

pub fn adc(&self, rhs: &Self, carry: Limb) -> (Self, Limb)

Computes a + b + carry, returning the result along with the new carry.

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

Perform wrapping addition, discarding overflow.

impl BoxedUint

pub fn zero() -> Self

Get the value 0, represented as succinctly as possible.

pub fn one() -> Self

Get the value 1, represented as succinctly as possible.

pub fn new(bits_precision: usize) -> Option<Self>

Create a new BoxedUint with the given number of bits of precision.

Returns None if the number of bits is not a multiple of the Limb size.

pub fn max(bits_precision: usize) -> Option<Self>

Get the maximum value for a given number of bits of precision.

Returns None if the number of bits is not a multiple of the Limb size.

pub fn from_words(words: &[Word]) -> Self

Create a BoxedUint from an array of Words (i.e. word-sized unsigned integers).

pub fn to_words(&self) -> Vec<Word>

Create an array of Words (i.e. word-sized unsigned integers) from a BoxedUint.

pub fn as_words(&self) -> &[Word]

Borrow the inner limbs as a slice of Words.

pub fn as_words_mut(&mut self) -> &mut [Word]

Borrow the inner limbs as a mutable array of Words.

pub fn as_limbs(&self) -> &[Limb]

Borrow the limbs of this BoxedUint.

pub fn as_limbs_mut(&mut self) -> &mut [Limb]

Borrow the limbs of this BoxedUint mutably.

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

Convert this BoxedUint into its inner limbs.

pub fn into_limbs(self) -> Vec<Limb>

Convert this BoxedUint into its inner limbs.

pub fn bits(&self) -> usize

Get the precision of this BoxedUint in bits.

Trait Implementations

impl AsMut<[Limb]> for BoxedUint

fn as_mut(&mut self) -> &mut [Limb]

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

impl AsMut<[u64]> for BoxedUint

fn as_mut(&mut self) -> &mut [Word]

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

impl AsRef<[Limb]> for BoxedUint

fn as_ref(&self) -> &[Limb]

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

impl AsRef<[u64]> for BoxedUint

fn as_ref(&self) -> &[Word]

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

impl CheckedAdd<&BoxedUint> for BoxedUint

type Output = BoxedUint

Output type.

fn checked_add(&self, rhs: &Self) -> CtOption<Self>

Perform checked subtraction, returning a CtOption which is_some only if the operation did not overflow.

impl Clone for BoxedUint

fn clone(&self) -> BoxedUint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConstantTimeEq for BoxedUint

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl Debug for BoxedUint

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

Formats the value using the given formatter.

impl Default for BoxedUint

fn default() -> BoxedUint

Returns the “default value” for a type.

impl Display for BoxedUint

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

Formats the value using the given formatter.

impl LowerHex for BoxedUint

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

Formats the value using the given formatter.

impl PartialEq for BoxedUint

fn eq(&self, other: &Self) -> 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 UpperHex for BoxedUint

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

Formats the value using the given formatter.

impl Zeroize for BoxedUint

Available on crate feature zeroize only.

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Eq for BoxedUint