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

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

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<Un, Bn> GetBit<UTerm> for UInt<Un, Bn>
[src]

impl<Un, Bn, Ui, Bi> GetBit<UInt<Ui, Bi>> for UInt<Un, Bn> where
    UInt<Ui, Bi>: Sub<B1>,
    Un: GetBit<Sub1<UInt<Ui, Bi>>>, 
[src]

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

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

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

impl<U: Unsigned + PowerOfTwo> PowerOfTwo for UInt<U, B0>
[src]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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<U: Unsigned, B: Bit> Cmp<UInt<U, B>> for UTerm
[src]

Zero < Nonzero

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<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<Ur: Unsigned, Br: Bit> PartialDiv<UInt<Ur, Br>> for UTerm
[src]

The type of the result of the division

Method for performing the division

impl<Ul: Unsigned, Bl: Bit, Ur: Unsigned, Br: Bit> PartialDiv<UInt<Ur, Br>> for UInt<Ul, Bl> where
    UInt<Ul, Bl>: Div<UInt<Ur, Br>> + Rem<UInt<Ur, Br>, Output = U0>, 
[src]

The type of the result of the division

Method for performing the division

impl<U, B, Ur> Min<Ur> for UInt<U, B> where
    U: Unsigned,
    B: Bit,
    Ur: Unsigned,
    UInt<U, B>: Cmp<Ur> + PrivateMin<Ur, Compare<UInt<U, B>, Ur>>, 
[src]

The type of the minimum of Self and Rhs

Method returning the minimum

impl<U, B, Ur> Max<Ur> for UInt<U, B> where
    U: Unsigned,
    B: Bit,
    Ur: Unsigned,
    UInt<U, B>: Cmp<Ur> + PrivateMax<Ur, Compare<UInt<U, B>, Ur>>, 
[src]

The type of the maximum of Self and Rhs

Method returning the maximum

impl<U: PartialEq, B: PartialEq> PartialEq<UInt<U, B>> 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: Eq, B: Eq> Eq for UInt<U, B>
[src]

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

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

impl<U: PartialOrd, B: PartialOrd> PartialOrd<UInt<U, B>> 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: Debug, B: Debug> Debug for UInt<U, B>
[src]

Formats the value using the given formatter. Read more

impl<Ur: Unsigned, Br: Bit> Div<UInt<Ur, Br>> for UTerm
[src]

The resulting type after applying the / operator.

Performs the / operation.

impl<Ul: Unsigned, Bl: Bit, Ur: Unsigned, Br: Bit> Div<UInt<Ur, Br>> for UInt<Ul, Bl> where
    UInt<Ul, Bl>: Len,
    Length<UInt<Ul, Bl>>: Sub<B1>,
    (): PrivateDiv<UInt<Ul, Bl>, UInt<Ur, Br>, U0, U0, Sub1<Length<UInt<Ul, Bl>>>>, 
[src]

The resulting type after applying the / operator.

Performs the / operation.

impl<Ur: Unsigned, Br: Bit> Rem<UInt<Ur, Br>> for UTerm
[src]

The resulting type after applying the % operator.

Performs the % operation.

impl<Ul: Unsigned, Bl: Bit, Ur: Unsigned, Br: Bit> Rem<UInt<Ur, Br>> for UInt<Ul, Bl> where
    UInt<Ul, Bl>: Len,
    Length<UInt<Ul, Bl>>: Sub<B1>,
    (): PrivateDiv<UInt<Ul, Bl>, UInt<Ur, Br>, U0, U0, Sub1<Length<UInt<Ul, Bl>>>>, 
[src]

The resulting type after applying the % operator.

Performs the % operation.

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

U + B0 = U

The resulting type after applying the + operator.

Performs the + operation.

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

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

The resulting type after applying the + operator.

Performs the + operation.

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

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

The resulting type after applying the + operator.

Performs the + operation.

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.

Performs the + operation.

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.

Performs the + operation.

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.

Performs the + operation.

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.

Performs the + operation.

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.

Performs the + operation.

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

UInt - B0 = UInt

The resulting type after applying the - operator.

Performs the - operation.

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.

Performs the - operation.

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

UInt<UTerm, B1> - B1 = UTerm

The resulting type after applying the - operator.

Performs the - operation.

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.

Performs the - operation.

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.

Performs the - operation.

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

UInt * B0 = UTerm

The resulting type after applying the * operator.

Performs the * operation.

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

UInt * B1 = UInt

The resulting type after applying the * operator.

Performs the * operation.

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

UInt<U, B> * UTerm = UTerm

The resulting type after applying the * operator.

Performs the * operation.

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.

Performs the * operation.

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.

Performs the * operation.

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.

Performs the & operation.

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

X | UTerm = X

The resulting type after applying the | operator.

Performs the | operation.

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.

Performs the | operation.

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.

Performs the | operation.

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.

Performs the | operation.

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.

Performs the | operation.

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.

Performs the ^ operation.

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.

Performs the << operation.

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.

Performs the << operation.

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.

Performs the << operation.

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.

Performs the << operation.

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.

Performs the >> operation.

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.

Performs the >> operation.

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.

Performs the >> operation.

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.

Performs the >> operation.

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

Feeds this value into the given [Hasher]. Read more

Feeds a slice of this type into the given [Hasher]. Read more

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

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: Default, B: Default> Default for UInt<U, B>
[src]

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

Auto Trait Implementations

impl<U, B> Send for UInt<U, B> where
    B: Send,
    U: Send

impl<U, B> Sync for UInt<U, B> where
    B: Sync,
    U: Sync

Blanket Implementations

impl<N, I, B> SetBit for N where
    N: PrivateSetBit<I, B>,
    <N as PrivateSetBit<I, B>>::Output: Trim, 
[src]

impl<T> Same for T
[src]

Should always be Self

impl<X, N> Pow for X where
    N: Unsigned,
    X: Unsigned + PrivatePow<UInt<UTerm, B1>, N>, 
[src]

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

impl<M, N> PartialDiv for M where
    M: Integer + Div<N> + Rem<N, Output = Z0>, 
[src]

The type of the result of the division

Method for performing the division

impl<A, B> IsLess for A where
    A: Cmp<B> + IsLessPrivate<B, <A as Cmp<B>>::Output>, 
[src]

The type representing either True or False

Method returning True or False.

impl<A, B> IsEqual for A where
    A: Cmp<B> + IsEqualPrivate<B, <A as Cmp<B>>::Output>, 
[src]

The type representing either True or False

Method returning True or False.

impl<A, B> IsGreater for A where
    A: Cmp<B> + IsGreaterPrivate<B, <A as Cmp<B>>::Output>, 
[src]

The type representing either True or False

Method returning True or False.

impl<A, B> IsLessOrEqual for A where
    A: Cmp<B> + IsLessOrEqualPrivate<B, <A as Cmp<B>>::Output>, 
[src]

The type representing either True or False

Method returning True or False.

impl<A, B> IsNotEqual for A where
    A: Cmp<B> + IsNotEqualPrivate<B, <A as Cmp<B>>::Output>, 
[src]

The type representing either True or False

Method returning True or False.

impl<A, B> IsGreaterOrEqual for A where
    A: Cmp<B> + IsGreaterOrEqualPrivate<B, <A as Cmp<B>>::Output>, 
[src]

The type representing either True or False

Method returning True or False.

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> From for T
[src]

Performs the conversion.

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> Into for T where
    U: From<T>, 
[src]

Performs the conversion.

impl<T> Borrow for T where
    T: ?Sized
[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut for T where
    T: ?Sized
[src]

Mutably borrows from an owned value. Read more

impl<T> Any for T where
    T: 'static + ?Sized
[src]

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

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more