Struct typenum::uint::UInt [] [src]

pub struct UInt<U, B> { /* fields omitted */ }

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, Unsigned};

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

Methods

impl<U: Unsigned, B: Bit> UInt<U, B>
[src]

Instantiates a singleton representing this unsigned integer.

Trait Implementations

impl<U: Eq, B: Eq> Eq for UInt<U, B>
[src]

impl<U: PartialEq, B: PartialEq> PartialEq for UInt<U, B>
[src]

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

impl<U: Ord, B: Ord> Ord for UInt<U, B>
[src]

This method returns an Ordering between self and other. Read more

impl<U: PartialOrd, B: PartialOrd> PartialOrd for UInt<U, B>
[src]

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

impl<U: Clone, B: Clone> Clone for UInt<U, B>
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl<U: Copy, B: Copy> Copy for UInt<U, B>
[src]

impl<U: Hash, B: Hash> Hash for UInt<U, B>
[src]

Feeds this value into the state given, updating the hasher as necessary.

Feeds a slice of this type into the state provided.

impl<U: Debug, B: Debug> Debug for UInt<U, B>
[src]

Formats the value using the given formatter.

impl<U: Default, B: Default> Default for UInt<U, B>
[src]

Returns the "default value" for a type. Read more

impl<U: Unsigned, B: Bit> Unsigned for UInt<U, B>
[src]

impl<U: Unsigned, B: Bit> NonZero for UInt<U, B>
[src]

impl<U: Unsigned, B: Bit> Len for UInt<U, B> where U: Len, Length<U>: Add<B1>, Add1<Length<U>>: Unsigned
[src]

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.

impl<U: Unsigned, B: Bit> Add<B0> for UInt<U, B>
[src]

U + B0 = U

The resulting type after applying the + operator

The method for the + operator

impl<U: Unsigned> Add<B1> for UInt<U, B0>
[src]

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

The resulting type after applying the + operator

The method for the + operator

impl<U: Unsigned> Add<B1> for UInt<U, B1> where U: Add<B1>, Sum<U, B1>: Unsigned
[src]

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

The resulting type after applying the + operator

The method for the + operator

impl<U: Unsigned, B: Bit> Add<UTerm> for UInt<U, B>
[src]

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

The resulting type after applying the + operator

The method for the + operator

impl<Ul: Unsigned, Ur: Unsigned> Add<UInt<Ur, B0>> for UInt<Ul, B0> where Ul: Add<Ur>
[src]

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

The resulting type after applying the + operator

The method for the + operator

impl<Ul: Unsigned, Ur: Unsigned> Add<UInt<Ur, B1>> for UInt<Ul, B0> where Ul: Add<Ur>
[src]

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

The resulting type after applying the + operator

The method for the + operator

impl<Ul: Unsigned, Ur: Unsigned> Add<UInt<Ur, B0>> for UInt<Ul, B1> where Ul: Add<Ur>
[src]

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

The resulting type after applying the + operator

The method for the + operator

impl<Ul: Unsigned, Ur: Unsigned> Add<UInt<Ur, B1>> for UInt<Ul, B1> where Ul: Add<Ur>, Sum<Ul, Ur>: Add<B1>
[src]

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

The resulting type after applying the + operator

The method for the + operator

impl<U: Unsigned, B: Bit> Sub<B0> for UInt<U, B>
[src]

UInt - B0 = UInt

The resulting type after applying the - operator

The method for the - operator

impl<U: Unsigned, B: Bit> Sub<B1> for UInt<UInt<U, B>, B1>
[src]

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

The resulting type after applying the - operator

The method for the - operator

impl Sub<B1> for UInt<UTerm, B1>
[src]

UInt<UTerm, B1> - B1 = UTerm

The resulting type after applying the - operator

The method for the - operator

impl<U: Unsigned> Sub<B1> for UInt<U, B0> where U: Sub<B1>, Sub1<U>: Unsigned
[src]

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

The resulting type after applying the - operator

The method for the - operator

impl<Ul: Unsigned, Bl: Bit, Ur: Unsigned> Sub<Ur> for UInt<Ul, Bl> where UInt<Ul, Bl>: PrivateSub<Ur>, PrivateSubOut<UInt<Ul, Bl>, Ur>: Trim
[src]

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

The resulting type after applying the - operator

The method for the - operator

impl<Ul: Unsigned, Bl: Bit, Ur: Unsigned> BitAnd<Ur> for UInt<Ul, Bl> where UInt<Ul, Bl>: PrivateAnd<Ur>, PrivateAndOut<UInt<Ul, Bl>, Ur>: Trim
[src]

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

The resulting type after applying the & operator

The method for the & operator

impl<B: Bit, U: Unsigned> BitOr<UTerm> for UInt<U, B>
[src]

X | UTerm = X

The resulting type after applying the | operator

The method for the | operator

impl<Ul: Unsigned, Ur: Unsigned> BitOr<UInt<Ur, B0>> for UInt<Ul, B0> where Ul: BitOr<Ur>
[src]

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

The resulting type after applying the | operator

The method for the | operator

impl<Ul: Unsigned, Ur: Unsigned> BitOr<UInt<Ur, B1>> for UInt<Ul, B0> where Ul: BitOr<Ur>
[src]

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

The resulting type after applying the | operator

The method for the | operator

impl<Ul: Unsigned, Ur: Unsigned> BitOr<UInt<Ur, B0>> for UInt<Ul, B1> where Ul: BitOr<Ur>
[src]

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

The resulting type after applying the | operator

The method for the | operator

impl<Ul: Unsigned, Ur: Unsigned> BitOr<UInt<Ur, B1>> for UInt<Ul, B1> where Ul: BitOr<Ur>
[src]

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

The resulting type after applying the | operator

The method for the | operator

impl<Ul: Unsigned, Bl: Bit, Ur: Unsigned> BitXor<Ur> for UInt<Ul, Bl> where UInt<Ul, Bl>: PrivateXor<Ur>, PrivateXorOut<UInt<Ul, Bl>, Ur>: Trim
[src]

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

The resulting type after applying the ^ operator

The method for the ^ operator

impl<U: Unsigned, B: Bit> Shl<UTerm> for UInt<U, B>
[src]

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

The resulting type after applying the << operator

The method for the << operator

impl<U: Unsigned, B: Bit> Shl<B0> for UInt<U, B>
[src]

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

The resulting type after applying the << operator

The method for the << operator

impl<U: Unsigned, B: Bit> Shl<B1> for UInt<U, B>
[src]

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

The resulting type after applying the << operator

The method for the << operator

impl<U: Unsigned, B: Bit, Ur: Unsigned, Br: Bit> Shl<UInt<Ur, Br>> for UInt<U, B> where UInt<Ur, Br>: Sub<B1>, UInt<UInt<U, B>, B0>: Shl<Sub1<UInt<Ur, Br>>>
[src]

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

The resulting type after applying the << operator

The method for the << operator

impl<U: Unsigned, B: Bit> Shr<UTerm> for UInt<U, B>
[src]

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

The resulting type after applying the >> operator

The method for the >> operator

impl<U: Unsigned, B: Bit> Shr<B0> for UInt<U, B>
[src]

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

The resulting type after applying the >> operator

The method for the >> operator

impl<U: Unsigned, B: Bit> Shr<B1> for UInt<U, B>
[src]

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

The resulting type after applying the >> operator

The method for the >> operator

impl<U: Unsigned, B: Bit, Ur: Unsigned, Br: Bit> Shr<UInt<Ur, Br>> for UInt<U, B> where UInt<Ur, Br>: Sub<B1>, U: Shr<Sub1<UInt<Ur, Br>>>
[src]

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

The resulting type after applying the >> operator

The method for the >> operator

impl<U: Unsigned, B: Bit> Mul<B0> for UInt<U, B>
[src]

UInt * B0 = UTerm

The resulting type after applying the * operator

The method for the * operator

impl<U: Unsigned, B: Bit> Mul<B1> for UInt<U, B>
[src]

UInt * B1 = UInt

The resulting type after applying the * operator

The method for the * operator

impl<U: Unsigned, B: Bit> Mul<UTerm> for UInt<U, B>
[src]

UInt<U, B> * UTerm = UTerm

The resulting type after applying the * operator

The method for the * operator

impl<Ul: Unsigned, B: Bit, Ur: Unsigned> Mul<UInt<Ur, B>> for UInt<Ul, B0> where Ul: Mul<UInt<Ur, B>>
[src]

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

The resulting type after applying the * operator

The method for the * operator

impl<Ul: Unsigned, B: Bit, Ur: Unsigned> Mul<UInt<Ur, B>> for UInt<Ul, B1> where Ul: Mul<UInt<Ur, B>>, UInt<Prod<Ul, UInt<Ur, B>>, B0>: Add<UInt<Ur, B>>
[src]

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

The resulting type after applying the * operator

The method for the * operator

impl<U: Unsigned, B: Bit> Cmp<UTerm> for UInt<U, B>
[src]

Nonzero > Zero

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

impl<Ul: Unsigned, Ur: Unsigned> Cmp<UInt<Ur, B0>> for UInt<Ul, B0> where Ul: PrivateCmp<Ur, Equal>
[src]

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.

impl<Ul: Unsigned, Ur: Unsigned> Cmp<UInt<Ur, B1>> for UInt<Ul, B1> where Ul: PrivateCmp<Ur, Equal>
[src]

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.

impl<Ul: Unsigned, Ur: Unsigned> Cmp<UInt<Ur, B1>> for UInt<Ul, B0> where Ul: PrivateCmp<Ur, Less>
[src]

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.

impl<Ul: Unsigned, Ur: Unsigned> Cmp<UInt<Ur, B0>> for UInt<Ul, B1> where Ul: PrivateCmp<Ur, Greater>
[src]

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.

impl<Ul: Unsigned, Bl: Bit, Ur: Unsigned> Div<Ur> for UInt<Ul, Bl> where UInt<Ul, Bl>: Cmp<Ur>, UInt<Ul, Bl>: PrivateDivFirstStep<Compare<UInt<Ul, Bl>, Ur>, Ur>
[src]

The resulting type after applying the / operator

The method for the / operator

impl<Ul: Unsigned, Bl: Bit, Ur: Unsigned> Rem<Ur> for UInt<Ul, Bl> where UInt<Ul, Bl>: Cmp<Ur>, UInt<Ul, Bl>: PrivateDivFirstStep<Compare<UInt<Ul, Bl>, Ur>, Ur>
[src]

The resulting type after applying the % operator

The method for the % operator