Struct Uint

#[repr(C)]
pub struct Uint<const N: usize>(/* private fields */);

A structure that represents large integers and provides basic arithmetic. It accepts a const generic N which controls the number of u64s used to represent the number.

Implementations

impl<const N: usize> Uint<N>

pub const MAX: Self

The maximum value that can be represented by this type

pub const MIN: Self

The minimum value that can be represented by this type

pub fn from_u64_array(data: [u64; N]) -> Self

Build a Uint from a u64 array

pub fn low_u32(&self) -> u32

Conversion to u32

pub fn low_u64(&self) -> u64

Conversion to u64

pub fn bits(&self) -> usize

Return the least number of bits needed to represent the number

pub fn mul_u32(self, other: u32) -> Self

Multiply by a u32

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

To litte-endian byte array

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

To big-endian byte array

pub fn from_le_bytes(bytes: impl AsRef<[u8]>) -> StacksResult<Self>

Build from a little-endian hex string (padding expected)

pub fn from_be_bytes(bytes: impl AsRef<[u8]>) -> StacksResult<Self>

Build from a big-endian hex string (padding expected)

pub fn to_le_hex(&self) -> String

Convert to a little-endian hex string

pub fn to_be_hex(&self) -> String

Convert to a big-endian hex string

pub fn from_le_hex(data: impl AsRef<str>) -> StacksResult<Self>

Build from a little-endian hex string

pub fn from_be_hex(data: impl AsRef<str>) -> StacksResult<Self>

Build from a big-endian hex string

pub fn increment(&mut self)

Wrapping add by one operation

pub fn from_uint<const M: usize>(source: impl AsRef<Uint<M>>) -> Self

Create a new Uint from the provided Uint

pub fn from_uint_lossy<const M: usize>(source: impl AsRef<Uint<M>>) -> Self

Create a new Uint from the provided Uint, truncating if necessary

pub fn to_uint<const M: usize>(&self) -> Uint<M>

Convert to a smaller Uint

pub fn to_uint_lossy<const M: usize>(&self) -> Uint<M>

Convert to a smaller Uint, truncating if necessary

Trait Implementations

impl<const N: usize> Add for Uint<N>

type Output = Uint<N>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<const N: usize> AsRef<Uint<N>> for Uint<N>

fn as_ref(&self) -> &Uint<N>

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

impl<const N: usize> BitAnd for Uint<N>

type Output = Uint<N>

The resulting type after applying the & operator.

fn bitand(self, other: Uint<N>) -> Self

Performs the & operation.

impl<const N: usize> BitOr for Uint<N>

type Output = Uint<N>

The resulting type after applying the | operator.

fn bitor(self, other: Uint<N>) -> Self

Performs the | operation.

impl<const N: usize> BitXor for Uint<N>

type Output = Uint<N>

The resulting type after applying the ^ operator.

fn bitxor(self, other: Uint<N>) -> Self

Performs the ^ operation.

impl<const N: usize> Clone for Uint<N>

fn clone(&self) -> Uint<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Codec for Uint<N>

fn codec_serialize<W: Write>(&self, dest: &mut W) -> Result<()>

Serialize to a writer

fn codec_deserialize<R: Read>(data: &mut R) -> Result<Self>

where Self: Sized,

Deserialize from a reader

fn serialize<W: Write>(&self, dest: &mut W) -> StacksResult<()>

Serialize to a writer and return a StacksResult

fn deserialize<R: Read>(data: &mut R) -> StacksResult<Self>

where Self: Sized,

Deserialize from a reader and return a StacksResult

fn serialize_to_vec(&self) -> Vec<u8>

Serialize to a vector

impl<const N: usize> Debug for Uint<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for Uint<N>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, const N: usize> Deserialize<'de> for Uint<N>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize> Display for Uint<N>

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

Formats the value using the given formatter.

impl<const N: usize> Div for Uint<N>

type Output = Uint<N>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<const N: usize> From<u128> for Uint<N>

fn from(value: u128) -> Self

Converts to this type from the input type.

impl<const N: usize> From<u16> for Uint<N>

fn from(value: u16) -> Self

Converts to this type from the input type.

impl<const N: usize> From<u32> for Uint<N>

fn from(value: u32) -> Self

Converts to this type from the input type.

impl<const N: usize> From<u64> for Uint<N>

fn from(value: u64) -> Self

Converts to this type from the input type.

impl<const N: usize> From<u8> for Uint<N>

fn from(value: u8) -> Self

Converts to this type from the input type.

impl<const N: usize> Into<Vec<u64>> for Uint<N>

fn into(self) -> Vec<u64>

Converts this type into the (usually inferred) input type.

impl<const N: usize> Mul for Uint<N>

type Output = Uint<N>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const N: usize> Not for Uint<N>

type Output = Uint<N>

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl<const N: usize> Ord for Uint<N>

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

impl<const N: usize> PartialEq for Uint<N>

fn eq(&self, other: &Uint<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const N: usize> PartialOrd for Uint<N>

fn partial_cmp(&self, other: &Self) -> 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<const N: usize> Serialize for Uint<N>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const N: usize> Shl<usize> for Uint<N>

type Output = Uint<N>

The resulting type after applying the << operator.

fn shl(self, shift: usize) -> Self

Performs the << operation.

impl<const N: usize> Shr<usize> for Uint<N>

type Output = Uint<N>

The resulting type after applying the >> operator.

fn shr(self, shift: usize) -> Self

Performs the >> operation.

impl<const N: usize> Sub for Uint<N>

type Output = Uint<N>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<const N: usize> TryFrom<Vec<u64>> for Uint<N>

type Error = StacksError

The type returned in the event of a conversion error.

fn try_from(value: Vec<u64>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize> Copy for Uint<N>

impl<const N: usize> Eq for Uint<N>

impl<const N: usize> StructuralPartialEq for Uint<N>