# Struct typenum::uint::UInt

pub struct UInt<U, B> { /* private fields */ }
Expand description

UInt is defined recursively, where B is the least significant bit and U is the rest of the number. Conceptually, U should be bound by the trait Unsigned and B should be bound by the trait Bit, but enforcing these bounds causes linear instead of logrithmic scaling in some places, so they are left off for now. They may be enforced in future.

In order to keep numbers unique, leading zeros are not allowed, so UInt<UTerm, B0> is forbidden.

## Example

use typenum::{UInt, UTerm, B0, B1};

type U6 = UInt<UInt<UInt<UTerm, B1>, B1>, B0>;

## Implementations§

Instantiates a singleton representing this unsigned integer.

## Trait Implementations§

U + B0 = U

The resulting type after applying the + operator.
Performs the + operation. Read more

UInt<U, B0> + B1 = UInt<U + B1>

The resulting type after applying the + operator.
Performs the + operation. Read more

UInt<U, B1> + B1 = UInt<U + B1, B0>

The resulting type after applying the + operator.
Performs the + operation. Read more

UInt<Ul, B0> + UInt<Ur, B0> = UInt<Ul + Ur, B0>

The resulting type after applying the + operator.
Performs the + operation. Read more

UInt<Ul, B1> + UInt<Ur, B0> = UInt<Ul + Ur, B1>

The resulting type after applying the + operator.
Performs the + operation. Read more

UInt<Ul, B0> + UInt<Ur, B1> = UInt<Ul + Ur, B1>

The resulting type after applying the + operator.
Performs the + operation. Read more

UInt<Ul, B1> + UInt<Ur, B1> = UInt<(Ul + Ur) + B1, B0>

The resulting type after applying the + operator.
Performs the + operation. Read more

UInt<U, B> + UTerm = UInt<U, B>

The resulting type after applying the + operator.
Performs the + operation. Read more

Anding unsigned integers. We use our PrivateAnd operator and then Trim the output.

The resulting type after applying the & operator.
Performs the & operation. Read more

UInt<Ul, B0> | UInt<Ur, B0> = UInt<Ul | Ur, B0>

The resulting type after applying the | operator.
Performs the | operation. Read more

UInt<Ul, B1> | UInt<Ur, B0> = UInt<Ul | Ur, B1>

The resulting type after applying the | operator.
Performs the | operation. Read more

UInt<Ul, B0> | UInt<Ur, B1> = UInt<Ul | Ur, B1>

The resulting type after applying the | operator.
Performs the | operation. Read more

UInt<Ul, B1> | UInt<Ur, B1> = UInt<Ul | Ur, B1>

The resulting type after applying the | operator.
Performs the | operation. Read more

X | UTerm = X

The resulting type after applying the | operator.
Performs the | operation. Read more

Xoring unsigned integers. We use our PrivateXor operator and then Trim the output.

The resulting type after applying the ^ operator.
Performs the ^ operation. Read more
Returns a copy of the value. Read more
Performs copy-assignment from source. Read more

Zero < Nonzero

The result of the comparison. It should only ever be one of Greater, Less, or Equal.

UInt<Ul, B0> cmp with UInt<Ur, B0>: SoFar is Equal

The result of the comparison. It should only ever be one of Greater, Less, or Equal.

UInt<Ul, B1> cmp with UInt<Ur, B0>: SoFar is Greater

The result of the comparison. It should only ever be one of Greater, Less, or Equal.

UInt<Ul, B0> cmp with UInt<Ur, B1>: SoFar is Less

The result of the comparison. It should only ever be one of Greater, Less, or Equal.

UInt<Ul, B1> cmp with UInt<Ur, B1>: SoFar is Equal

The result of the comparison. It should only ever be one of Greater, Less, or Equal.

Nonzero > Zero

The result of the comparison. It should only ever be one of Greater, Less, or Equal.
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
The resulting type after applying the / operator.
Performs the / operation. Read more
The resulting type after applying the / operator.
Performs the / operation. Read more

gcd(x, y) = 2*gcd(x/2, y/2) if both x and y even

The greatest common divisor.

gcd(x, y) = gcd(x, y/2) if x odd and y even

The greatest common divisor.

gcd(x, y) = gcd(x/2, y) if x even and y odd

The greatest common divisor.

gcd(x, y) = gcd([max(x, y) - min(x, y)], min(x, y)) if both x and y odd

This will immediately invoke the case for x even and y odd because the difference of two odd numbers is an even number.

The greatest common divisor.
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more

Length of a bit is 1

The length as a type-level unsigned integer.
This function isn’t used in this crate, but may be useful for others.
The type of the maximum of Self and Rhs
Method returning the maximum
The type of the minimum of Self and Rhs
Method returning the minimum

UInt * B0 = UTerm

The resulting type after applying the * operator.
Performs the * operation. Read more

UInt * B1 = UInt

The resulting type after applying the * operator.
Performs the * operation. Read more

UInt<Ul, B0> * UInt<Ur, B> = UInt<(Ul * UInt<Ur, B>), B0>

The resulting type after applying the * operator.
Performs the * operation. Read more

UInt<Ul, B1> * UInt<Ur, B> = UInt<(Ul * UInt<Ur, B>), B0> + UInt<Ur, B>

The resulting type after applying the * operator.
Performs the * operation. Read more

UInt<U, B> * UTerm = UTerm

The resulting type after applying the * operator.
Performs the * operation. Read more
This method returns an Ordering between self and other. Read more
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
Restrict a value to a certain interval. Read more
The type of the result of the division
Method for performing the division
The type of the result of the division
Method for performing the division
This method tests for self and other values to be equal, and is used by ==.
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
The result of the exponentiation.
This function isn’t used in this crate, but may be useful for others. It is implemented for primitives. Read more
The result of the exponentiation.
This function isn’t used in this crate, but may be useful for others. It is implemented for primitives. Read more
The result of the exponentiation.
This function isn’t used in this crate, but may be useful for others. It is implemented for primitives. Read more
The result of the exponentiation.
This function isn’t used in this crate, but may be useful for others. It is implemented for primitives. Read more
The result of the exponentiation.
This function isn’t used in this crate, but may be useful for others. It is implemented for primitives. Read more
The result of the exponentiation.
This function isn’t used in this crate, but may be useful for others. It is implemented for primitives. Read more
The result of the exponentiation.
This function isn’t used in this crate, but may be useful for others. It is implemented for primitives. Read more
The result of the exponentiation.
This function isn’t used in this crate, but may be useful for others. It is implemented for primitives. Read more
The result of the exponentiation.
This function isn’t used in this crate, but may be useful for others. It is implemented for primitives. Read more
The result of the exponentiation.
This function isn’t used in this crate, but may be useful for others. It is implemented for primitives. Read more
The result of the exponentiation.
This function isn’t used in this crate, but may be useful for others. It is implemented for primitives. Read more
The result of the exponentiation.
This function isn’t used in this crate, but may be useful for others. It is implemented for primitives. Read more
The resulting type after applying the % operator.
Performs the % operation. Read more
The resulting type after applying the % operator.
Performs the % operation. Read more

Shifting left any unsigned by a zero bit: U << B0 = U

The resulting type after applying the << operator.
Performs the << operation. Read more

Shifting left a UInt by a one bit: UInt<U, B> << B1 = UInt<UInt<U, B>, B0>

The resulting type after applying the << operator.
Performs the << operation. Read more

Shifting left UInt by UInt: X << Y = UInt(X, B0) << (Y - 1)

The resulting type after applying the << operator.
Performs the << operation. Read more

Shifting left UInt by UTerm: UInt<U, B> << UTerm = UInt<U, B>

The resulting type after applying the << operator.
Performs the << operation. Read more

Shifting right any unsigned by a zero bit: U >> B0 = U

The resulting type after applying the >> operator.
Performs the >> operation. Read more

Shifting right a UInt by a 1 bit: UInt<U, B> >> B1 = U

The resulting type after applying the >> operator.
Performs the >> operation. Read more

Shifting right UInt by UInt: UInt(U, B) >> Y = U >> (Y - 1)

The resulting type after applying the >> operator.
Performs the >> operation. Read more

Shifting right UInt by UTerm: UInt<U, B> >> UTerm = UInt<U, B>

The resulting type after applying the >> operator.
Performs the >> operation. Read more

UInt - B0 = UInt

The resulting type after applying the - operator.
Performs the - operation. Read more

UInt<U, B0> - B1 = UInt<U - B1, B1>

The resulting type after applying the - operator.
Performs the - operation. Read more

UInt<U, B1> - B1 = UInt<U, B0>

The resulting type after applying the - operator.
Performs the - operation. Read more

UInt<UTerm, B1> - B1 = UTerm

The resulting type after applying the - operator.
Performs the - operation. Read more

Subtracting unsigned integers. We just do our PrivateSub and then Trim the output.

The resulting type after applying the - operator.
Performs the - operation. Read more
Method returning the concrete value for the type.
Method returning the concrete value for the type.
Method returning the concrete value for the type.
Method returning the concrete value for the type.
Method returning the concrete value for the type.
Method returning the concrete value for the type.
Method returning the concrete value for the type.
Method returning the concrete value for the type.
Method returning the concrete value for the type.

## Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

The greatest common divisor.

Calls U::from(self).

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

The result of the integer binary logarithm.
The result of the exponentiation.
This function isn’t used in this crate, but may be useful for others. It is implemented for primitives. Read more
Should always be Self
The result of the integer square root.
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.