`pub struct UInt<U, B> { /* fields omitted */ }`
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::{B0, B1, UInt, UTerm};

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, B1> + B1 = UInt<U + B1, B0>`

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<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, B0> = UInt<Ul + Ur, B0>`

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<Ul, B0> + UInt<Ur, B1> = UInt<Ul + Ur, B1>`

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

`type ArrayType`

Associated type representing the array type for the number

`type ArrayType`

Associated type representing the array type for the number

`type ArrayType`

Associated type representing the array type for the number

`type ArrayType`

Associated type representing the array type for the number

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, 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, B0> = UInt<Ul | Ur, B0>`

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, 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, 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, B1>`: `SoFar` is `Equal`

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`.

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([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.

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

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 `==`. Read more

This method tests for `!=`.

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

## 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

Convert from a value of `T` into an equivalent instance of `Option<Self>`. Read more

Consume self to return `Some` equivalent value of `Option<T>`. Read more

True iff no bits are set.

Return the value of Self that is clear.

Convert `Box<dyn Trait>` (where `Trait: Downcast`) to `Box<dyn Any>`. `Box<dyn Any>` can then be further `downcast` into `Box<ConcreteType>` where `ConcreteType` implements `Trait`. Read more

Convert `Rc<Trait>` (where `Trait: Downcast`) to `Rc<Any>`. `Rc<Any>` can then be further `downcast` into `Rc<ConcreteType>` where `ConcreteType` implements `Trait`. Read more

Convert `&Trait` (where `Trait: Downcast`) to `&Any`. This is needed since Rust cannot generate `&Any`’s vtable from `&Trait`’s. Read more

Convert `&mut Trait` (where `Trait: Downcast`) to `&Any`. This is needed since Rust cannot generate `&mut Any`’s vtable from `&mut Trait`’s. Read more

Convert `Arc<Trait>` (where `Trait: Downcast`) to `Arc<Any>`. `Arc<Any>` can then be further `downcast` into `Arc<ConcreteType>` where `ConcreteType` implements `Trait`. Read more

Compare self to `key` and return `true` if they are equal.

Performs the conversion.

The greatest common divisor.

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more

Performs the conversion.

Get a reference to the inner from the outer.

Get a mutable reference to the inner from the outer.

The result of the integer binary logarithm.

The alignment of pointer.

The type for initializers.

Initializes a with the given initializer. Read more

Dereferences the given pointer. Read more

Mutably dereferences the given pointer. Read more

Drops the object pointed to by the given pointer. 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

Should always be `Self`

Convert from a value of `T` into an equivalent instance of `Self`. Read more

Consume self to return an equivalent value of `T`. Read more

The result of the integer square root.

The resulting type after obtaining ownership.

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

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

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

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.

The counterpart to `unchecked_from`.

Consume self to return an equivalent value of `T`.

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more