typenum

https://docs.rs/typenum/1.19.0/typenum/
Admin
typenum is a Rust library that provides type-level numbers and compile-time type arithmetic with...
Tokens:2,523,919
Snippets:16,991
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Bit and Order Implementations

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U150.html

Covers getting specific bits and ordering for UInt.

```APIDOC
## Get Bit Implementation

### Description
Retrieves a specific bit from a `UInt<Un, Bn>`.

### Method
`get_bit`

### Endpoint
N/A (Implementation detail)

### Parameters
- **UInt<Ui, Bi>** (`UInt<Ui, Bi>`): The index of the bit to retrieve.

### Request Body
None

### Response
#### Success Response (200)
- **Output** (Type): The value of the specified bit.

### Response Example
```json
{
  "Output": "<bit_value>"
}
```

## Ord Implementation

### Description
Provides total ordering for `UInt<U, B>` types.

### Method
`cmp` (inherent from Ord trait)

### Endpoint
N/A (Implementation detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Ordering** (Ordering): The result of the comparison (`Less`, `Equal`, `Greater`).

### Response Example
```json
{
  "Ordering": "Less"
}
```
```

--------------------------------

### Bit and Max/Min Implementations

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U312.html

Implementations for getting bits, and finding maximum and minimum values.

```APIDOC
## GetBit<UInt<Ui, Bi>> for UInt<Un, Bn>

### Description
Retrieves a specific bit from a `UInt<Un, Bn>`.

### Method
`get_bit`

### Endpoint
N/A (Implementation detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Output** (type) - The value of the requested bit.

### Response Example
```json
{
  "example": "<Un as GetBit<<UInt<Ui, Bi> as Sub<B1>>::Output>>::Output"
}
```

## GetBit<UTerm> for UInt<Un, Bn>

### Description
Retrieves a specific bit from a `UInt<Un, Bn>` when the index is `UTerm`.

### Method
`get_bit`

### Endpoint
N/A (Implementation detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Output** (*Bn*) - The value of the requested bit.

### Response Example
```json
{
  "example": "Bn"
}
```

## Max<Ur> for UInt<U, B>

### Description
Determines the maximum value between `UInt<U, B>` and `Ur`.

### Method
`max`

### Endpoint
N/A (Implementation detail)

### Parameters
- **rhs** (*Ur*) - The other value to compare.

### Request Body
None

### Response
#### Success Response (200)
- **Output** (type) - The type of the maximum of `Self` and `Rhs`.

### Response Example
```json
{
  "example": "<UInt<U, B> as PrivateMax<Ur, ...>>::Output"
}
```

## Min<Ur> for UInt<U, B>

### Description
Determines the minimum value between `UInt<U, B>` and `Ur`.

### Method
`min`

### Endpoint
N/A (Implementation detail)

### Parameters
- **rhs** (*Ur*) - The other value to compare.

### Request Body
None

### Response
#### Success Response (200)
- **Output** (type) - The type of the minimum of `Self` and `Rhs`.

### Response Example
```json
{
  "example": "<UInt<U, B> as PrivateMin<Ur, ...>>::Output"
}
```
```

--------------------------------

### Utility Implementations

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U238.html

Details on Debug, Default, GetBit, Hash, and Len implementations for UInt.

```APIDOC
## Utility Implementations

### `impl<U: Debug, B: Debug> Debug for UInt<U, B>`

Implements the `Debug` trait for `UInt`.

#### Method `fmt`

- **Description**: Formats the value using the given formatter.
- **Parameters**: `f` (&mut Formatter<'_>)
- **Returns**: `Result`

### `impl<U: Default, B: Default> Default for UInt<U, B>`

Implements the `Default` trait for `UInt`.

#### Method `default`

- **Description**: Returns the “default value” for a type.
- **Returns**: `UInt<U, B>`

### `impl<Un, Bn, Ui, Bi> GetBit<UInt<Ui, Bi>> for UInt<Un, Bn>`

Retrieves a specific bit from a `UInt`.

#### Type `Output`

- **Type**: `<Un as GetBit<<UInt<Ui, Bi> as Sub<B1>>::Output>>::Output`

### `impl<Un, Bn> GetBit<UTerm> for UInt<Un, Bn>`

Retrieves the least significant bit of a `UInt`.

#### Type `Output`

- **Type**: `Bn`
- **Description**: The value of the least significant bit.

### `impl<U: Hash, B: Hash> Hash for UInt<U, B>`

Implements the `Hash` trait for `UInt`.

#### Method `hash`

- **Description**: Feeds this value into the given `Hasher`.
- **Parameters**: `state` (&mut __H)

#### Method `hash_slice`

- **Description**: Feeds a slice of this type into the given `Hasher`.
- **Parameters**: `data` (&[Self]), `state` (&mut H)

### `impl<U, B: Bit> Len for UInt<U, B>`

Calculates the length of the `UInt`.

#### Type `Output`

- **Type**: `<<U as Len>::Output as Add<B1>>::Output`
- **Description**: The length as a type-level unsigned integer.

#### Method `len`

- **Description**: This function isn’t used in this crate, but may be useful for others.
- **Returns**: `Self::Output`
```

--------------------------------

### Gcd Usage Example

Source: https://docs.rs/typenum/1.19.0/typenum/type_operators/trait.Gcd.html

Example demonstrating how to use the Gcd trait to compute the GCD of two unsigned integers.

```rust
use typenum::{Gcd, Unsigned, U12, U8};

assert_eq!(<U12 as Gcd<U8>>::Output::to_i32(), 4);
```

--------------------------------

### Max, Min, and Hashing Implementations for UInt

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U174.html

Details the implementations for finding the maximum and minimum of two UInt values, and for hashing.

```APIDOC
## Max, Min, and Hashing Implementations for UInt

### `impl<U, B, Ur> Max<Ur> for UInt<U, B>`

Implements the `Max` trait to find the maximum between `UInt<U, B>` and `Ur`.

#### Type `Output`

- **Type**: `<UInt<U, B> as PrivateMax<Ur, <UInt<U, B> as Cmp<Ur>>::Output>>::Output`
- **Description**: The type of the maximum of `Self` and `Rhs`.

#### Function `max`

- **Signature**: `fn max(self, rhs: Ur) -> Self::Output`
- **Description**: Method returning the maximum of `self` and `rhs`.

### `impl<U, B, Ur> Min<Ur> for UInt<U, B>`

Implements the `Min` trait to find the minimum between `UInt<U, B>` and `Ur`.

#### Type `Output`

- **Type**: `<UInt<U, B> as PrivateMin<Ur, <UInt<U, B> as Cmp<Ur>>::Output>>::Output`
- **Description**: The type of the minimum of `Self` and `Rhs`.

#### Function `min`

- **Signature**: `fn min(self, rhs: Ur) -> Self::Output`
- **Description**: Method returning the minimum of `self` and `rhs`.

### `impl<U: Hash, B: Hash> Hash for UInt<U, B>`

Implements the `Hash` trait for `UInt<U, B>`.

#### Function `hash`

- **Signature**: `fn hash<__H: Hasher>(&self, state: &mut __H)`
- **Description**: Feeds this value into the given `Hasher`.

#### Function `hash_slice`

- **Signature**: `fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher, Self: Sized`
- **Description**: Feeds a slice of this type into the given `Hasher`.
```

--------------------------------

### Get concrete isize value for NInt

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.N100.html

Use this constant in `const` contexts to get the concrete isize value represented by the NInt type.

```rust
const INT: isize = Self::ISIZE;
```

--------------------------------

### Get concrete i8 value for NInt

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.N100.html

Use this constant in `const` contexts to get the concrete i8 value represented by the NInt type.

```rust
const INT: i8 = Self::I8;
```

--------------------------------

### Max, Min, and Hashing for UInt

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U214.html

Details the implementations for finding the maximum/minimum of two UInt values and hashing.

```APIDOC
## Max, Min, and Hashing for UInt

### `impl<U, B, Ur> Max<Ur> for UInt<U, B>`

Implements the `Max` trait to find the maximum between `UInt<U, B>` and `Ur`.

#### Type `Output`

The type of the maximum of `Self` and `Rhs`.

#### Function `max`

Method returning the maximum of `Self` and `Rhs`.

### `impl<U, B, Ur> Min<Ur> for UInt<U, B>`

Implements the `Min` trait to find the minimum between `UInt<U, B>` and `Ur`.

#### Type `Output`

The type of the minimum of `Self` and `Rhs`.

#### Function `min`

Method returning the minimum of `Self` and `Rhs`.

### `impl<U: Hash, B: Hash> Hash for UInt<U, B>`

Implements the `Hash` trait for `UInt<U, B>`.

#### Function `hash`

Feeds this value into the given `Hasher`.

#### Function `hash_slice`

Feeds a slice of this type into the given `Hasher`.
```

--------------------------------

### Get concrete i64 value for NInt

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.N100.html

Use this constant in `const` contexts to get the concrete i64 value represented by the NInt type.

```rust
const INT: i64 = Self::I64;
```

--------------------------------

### Debug and Default Implementations for UInt

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U522.html

Provides information on how to format and initialize UInt types.

```APIDOC
## Debug for UInt<U, B>

### Description
Implements the `Debug` trait for `UInt<U, B>`.

### Method
`fmt`

### Endpoint
N/A (Implementation detail)

### Parameters
- **f** (*Formatter*) - The formatter to use.

### Request Body
None

### Response
#### Success Response (200)
- **Result** (*Result*) - The result of the formatting operation.

### Response Example
N/A (This is a formatting function)

## Default for UInt<U, B>

### Description
Implements the `Default` trait for `UInt<U, B>`.

### Method
`default`

### Endpoint
N/A (Implementation detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Output** (*UInt<U, B>*) - The default value for the type.

### Response Example
```json
{
  "Output": "<default_uint_value>"
}
```
```

--------------------------------

### Utility Implementations

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U192.html

Details on Debug, Default, Hash, and Len implementations for UInt.

```APIDOC
## Debug for UInt<U, B>

### Description
Implements the `Debug` trait for `UInt<U, B>`, allowing it to be formatted for debugging.

### Method
`fmt`

### Endpoint
N/A (Implementation detail)

### Parameters
- **f** (&mut Formatter<'_>) - The formatter to use.

### Request Body
None

### Response
#### Success Response (200)
- **Result** (Result) - The result of the formatting operation.

#### Response Example
N/A (Implementation detail)

## Default for UInt<U, B>

### Description
Implements the `Default` trait for `UInt<U, B>`, providing a default value.

### Method
`default`

### Endpoint
N/A (Implementation detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Output** (UInt<U, B>) - The default value for `UInt<U, B>`.

#### Response Example
N/A (Implementation detail)

## Hash for UInt<U, B>

### Description
Implements the `Hash` trait for `UInt<U, B>`, allowing it to be used in hash-based collections.

### Method
`hash`

### Endpoint
N/A (Implementation detail)

### Parameters
- **state** (&mut __H) - The hasher state.

### Request Body
None

### Response
#### Success Response (200)
None (modifies hasher state)

#### Response Example
N/A (Implementation detail)

### Method
`hash_slice`

### Endpoint
N/A (Implementation detail)

### Parameters
- **data** (&[Self]) - The slice of `UInt` values to hash.
- **state** (&mut H) - The hasher state.

### Request Body
None

### Response
#### Success Response (200)
None (modifies hasher state)

#### Response Example
N/A (Implementation detail)

## Len for UInt<U, B>

### Description
Implements the `Len` trait for `UInt<U, B>`, providing its length as a type-level unsigned integer.

### Method
`len`

### Endpoint
N/A (Implementation detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Output** (Type) - The length of the `UInt`.

#### Response Example
N/A (Implementation detail)
```

--------------------------------

### Get concrete i32 value for NInt

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.N100.html

Use this constant in `const` contexts to get the concrete i32 value represented by the NInt type.

```rust
const INT: i32 = Self::I32;
```

--------------------------------

### Utility Implementations

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U1014.html

Details on implementations for Debug, Default, GetBit, Hash, and Len.

```APIDOC
## Debug for UInt<U, B>

### Description
Implements the `Debug` trait for `UInt<U, B>`.

### Method
`fmt`

### Endpoint
N/A (Implementation Detail)

### Parameters
- **f** (&mut Formatter<'_>) - The formatter to use.

### Request Body
None

### Response
#### Success Response (200)
- **Result** (Result) - The result of the formatting operation.

### Response Example
```json
{
  "example": "Result Type"
}
```

## Default for UInt<U, B>

### Description
Implements the `Default` trait for `UInt<U, B>`.

### Method
`default`

### Endpoint
N/A (Implementation Detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Output** (UInt<U, B>) - The default value for `UInt<U, B>`.

### Response Example
```json
{
  "example": "UInt<U, B>"
}
```

## GetBit<UInt<Ui, Bi>> for UInt<Un, Bn>

### Description
Retrieves a specific bit from `UInt<Un, Bn>`.

### Method
`get_bit` (implied)

### Endpoint
N/A (Implementation Detail)

### Parameters
- **UInt<Ui, Bi>** - Represents the index of the bit to retrieve.

### Request Body
None

### Response
#### Success Response (200)
- **Output** (Type) - The value of the bit at the specified index.

### Response Example
```json
{
  "example": "Bit Value Type"
}
```

## GetBit<UTerm> for UInt<Un, Bn>

### Description
Retrieves a specific bit from `UInt<Un, Bn>` when the index is `UTerm`.

### Method
`get_bit` (implied)

### Endpoint
N/A (Implementation Detail)

### Parameters
- **UTerm** - Represents the index of the bit to retrieve (zero).

### Request Body
None

### Response
#### Success Response (200)
- **Output** (Bn) - The value of the least significant bit.

### Response Example
```json
{
  "example": "Bn"
}
```

## Hash for UInt<U, B>

### Description
Implements the `Hash` trait for `UInt<U, B>`.

### Method
`hash`, `hash_slice`

### Endpoint
N/A (Implementation Detail)

### Parameters
- **state** (<__H: Hasher>) - The hasher state.
- **data** (&[Self]) - The slice of `UInt` values to hash.

### Request Body
None

### Response
#### Success Response (200)
None (modifies hasher state)

### Response Example
```json
{
  "example": "Hasher State Modified"
}
```

## Len for UInt<U, B>

### Description
Calculates the length of `UInt<U, B>` as a type-level unsigned integer.

### Method
`len`

### Endpoint
N/A (Implementation Detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Output** (Type) - The length of the `UInt`.

### Response Example
```json
{
  "example": "Length Type"
}
```
```

--------------------------------

### Get Absolute Value of a Negative Integer

Source: https://docs.rs/typenum/1.19.0/typenum/type_operators/trait.Abs.html

Use the Abs trait to get the absolute value of a negative integer type. Ensure the necessary types are imported.

```rust
use typenum::{Abs, Integer, N5};

assert_eq!(<N5 as Abs>::Output::to_i32(), 5);
```

--------------------------------

### Length Implementation for UInt

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U645.html

Details on how to get the length of a UInt.

```APIDOC
## GET /api/products

### Description
Retrieves a list of available products.

### Method
GET

### Endpoint
/api/products

### Parameters
#### Path Parameters
None

#### Query Parameters
- **category** (string) - Optional - Filters products by category.
- **limit** (integer) - Optional - Limits the number of products returned.
- **offset** (integer) - Optional - Skips a specified number of products.

#### Request Body
None

### Request Example
```
GET /api/products?category=electronics&limit=10
```

### Response
#### Success Response (200)
- **products** (array) - A list of product objects.
  - **id** (string) - The unique identifier for the product.
  - **name** (string) - The name of the product.
  - **price** (number) - The price of the product.
  - **category** (string) - The category of the product.

#### Response Example
```json
{
  "products": [
    {
      "id": "prod_abc123",
      "name": "Laptop",
      "price": 1200.00,
      "category": "electronics"
    },
    {
      "id": "prod_def456",
      "name": "Keyboard",
      "price": 75.00,
      "category": "electronics"
    }
  ]
}
```
```

--------------------------------

### Utility Implementations

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U1000000000000.html

Includes implementations for Debug, Default, GetBit, Hash, Len, Max, and Min.

```APIDOC
## Utility Implementations for UInt

### `impl<U: Debug, B: Debug> Debug for UInt<U, B>`

Provides debugging capabilities for the `UInt<U, B>` type.

#### Function `fmt`
- Signature: `fn fmt(&self, f: &mut Formatter<'_>) -> Result`
- Description: Formats the value using the given formatter.

### `impl<U: Default, B: Default> Default for UInt<U, B>`

Provides default value functionality for `UInt<U, B>`.

#### Function `default`
- Signature: `fn default() -> UInt<U, B>`
- Description: Returns the default value for the type.

### `impl<Un, Bn, Ui, Bi> GetBit<UInt<Ui, Bi>> for UInt<Un, Bn>`

Retrieves a specific bit from `UInt<Un, Bn>`.

#### Type `Output`
- Type: `<Un as GetBit<<UInt<Ui, Bi> as Sub<B1>>::Output>>::Output`

### `impl<Un, Bn> GetBit<UTerm> for UInt<Un, Bn>`

Retrieves a specific bit from `UInt<Un, Bn>` when the index is `UTerm`.

#### Type `Output`
- Type: `Bn`

### `impl<U: Hash, B: Hash> Hash for UInt<U, B>`

Provides hashing capabilities for `UInt<U, B>`.

#### Function `hash`
- Signature: `fn hash<__H: Hasher>(&self, state: &mut __H)`
- Description: Feeds this value into the given `Hasher`.

#### Function `hash_slice`
- Signature: `fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher, Self: Sized`
- Description: Feeds a slice of this type into the given `Hasher`.

### `impl<U, B: Bit> Len for UInt<U, B>`

Calculates the length of the `UInt<U, B>` type.

- Rule: Length of a bit is 1.

#### Type `Output`
- Type: `<<U as Len>::Output as Add<B1>>::Output`
- Description: The length as a type-level unsigned integer.

#### Function `len`
- Signature: `fn len(&self) -> Self::Output`
- Description: This function isn’t used in this crate, but may be useful for others.

### `impl<U, B, Ur> Max<Ur> for UInt<U, B>`

Determines the maximum between `UInt<U, B>` and `Ur`.

#### Type `Output`
- Type: `<UInt<U, B> as PrivateMax<Ur, <UInt<U, B> as Cmp<Ur>>::Output>>::Output`
- Description: The type of the maximum of `Self` and `Rhs`.

#### Function `max`
- Signature: `fn max(self, rhs: Ur) -> Self::Output`
- Description: Method returning the maximum.

### `impl<U, B, Ur> Min<Ur> for UInt<U, B>`

Determines the minimum between `UInt<U, B>` and `Ur`.

#### Type `Output`
- Type: `<UInt<U, B> as PrivateMin<Ur, <UInt<U, B> as Cmp<Ur>>::Output>>::Output`
- Description: The type of the minimum of `Self` and `Rhs`.

#### Function `min`
- Signature: `fn min(self, rhs: Ur) -> Self::Output`
- Description: Method returning the minimum.
```

--------------------------------

### Utility Implementations for UInt

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U460.html

Covers Debug, Default, GetBit, Hash, and Len implementations for UInt.

```APIDOC
## Debug for UInt<U, B>

### Description
Implementation of the `Debug` trait for `UInt<U, B>`, allowing formatted output for debugging.

### Method
`fmt`

### Endpoint
N/A (Implementation detail)

### Parameters
- **f** (&mut Formatter<'_>) - The formatter to use.

### Request Body
None

### Response
#### Success Response (200)
- **Result** (Result) - The result of the formatting operation.

#### Response Example
```rust
let val: UInt<U, B> = ...;
println!("{:?}", val);
```

## Default for UInt<U, B>

### Description
Implementation of the `Default` trait for `UInt<U, B>`, providing a default value.

### Method
`default`

### Endpoint
N/A (Implementation detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Output** (UInt<U, B>) - The default value for `UInt<U, B>`.

#### Response Example
```rust
let default_val: UInt<U, B> = UInt::default();
```

## GetBit<UInt<Ui, Bi>> for UInt<Un, Bn>

### Description
Retrieves a specific bit from `UInt<Un, Bn>` at the position specified by `UInt<Ui, Bi>`.

### Method
`get_bit`

### Endpoint
N/A (Implementation detail)

### Parameters
- **bit_index** (UInt<Ui, Bi>) - The index of the bit to retrieve.

### Request Body
None

### Response
#### Success Response (200)
- **Output** (Type) - The value of the bit at the specified index.

#### Response Example
```rust
let num: UInt<Un, Bn> = ...;
let bit_index: UInt<Ui, Bi> = ...;
let bit_value = num.get_bit(bit_index);
```

## GetBit<UTerm> for UInt<Un, Bn>

### Description
Retrieves the bit at the `UTerm` position (which is typically the least significant bit if `UTerm` represents 0).

### Method
`get_bit`

### Endpoint
N/A (Implementation detail)

### Parameters
- **_** (UTerm) - Represents the bit position (often the LSB).

### Request Body
None

### Response
#### Success Response (200)
- **Output** (Bn) - The value of the bit.

#### Response Example
```rust
let num: UInt<Un, Bn> = ...;
let bit_value = num.get_bit(UTerm);
```

## Hash for UInt<U, B>

### Description
Implementation of the `Hash` trait for `UInt<U, B>`, enabling hashing of `UInt` values.

### Method
`hash` and `hash_slice`

### Endpoint
N/A (Implementation detail)

### Parameters
- **state** (&mut H) - The hasher state.
- **data** (&[Self]) - The slice of `UInt` values to hash.

### Request Body
None

### Response
None

#### Response Example
```rust
use std::collections::hash_map::DefaultHasher;
use std::hash::{Hash, Hasher};

let val: UInt<U, B> = ...;
let mut hasher = DefaultHasher::new();
val.hash(&mut hasher);
let hash_value = hasher.finish();
```

## Len for UInt<U, B>

### Description
Calculates the length (number of bits) of a `UInt<U, B>` type.

### Method
`len`

### Endpoint
N/A (Implementation detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Output** (Type) - The length of the `UInt` as a type-level unsigned integer.

#### Response Example
```rust
let val: UInt<U, B> = ...;
let length = val.len();
```
```

--------------------------------

### Bit Manipulation and Hashing

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U10000000000.html

Implementations for getting bits and hashing.

```APIDOC
## impl<Un, Bn, Ui, Bi> GetBit<UInt<Ui, Bi>> for UInt<Un, Bn>

### Description
Retrieves a specific bit from a `UInt` type.

### Method
GetBit

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **Output** (type) - The value of the requested bit.

#### Response Example
```json
{
  "example": "Bit value (0 or 1)"
}
```
```

```APIDOC
## impl<Un, Bn> GetBit<UTerm> for UInt<Un, Bn>

### Description
Retrieves a specific bit from a `UInt` type when the index is `UTerm`.

### Method
GetBit

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **Output** (Bn) - The value of the bit, which is `Bn`.

#### Response Example
```json
{
  "example": "Bn"
}
```
```

```APIDOC
## impl<U: Hash, B: Hash> Hash for UInt<U, B>

### Description
Provides hashing capabilities for the `UInt` type.

### Method
hash

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **Result** (Result) - Feeds this value into the given `Hasher`.

#### Response Example
N/A
```

```APIDOC
## impl<H: Hasher, Self: Sized> hash_slice<H>(data: &[Self], state: &mut H)

### Description
Feeds a slice of `UInt` types into the given `Hasher`.

### Method
hash_slice

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **Result** (Result) - Feeds a slice of this type into the given `Hasher`.

#### Response Example
N/A
```

--------------------------------

### Default Implementation

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U526.html

Details on how to get the default value for the UInt type.

```APIDOC
## Default for UInt<U, B>

### Description
Provides the default value for the `UInt<U, B>` type.

### Method
`default`

### Endpoint
N/A (Implementation Detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Output** (UInt<U, B>) - The default value of the type.

### Response Example
```json
{
  "example": "Default UInt Value"
}
```
```

--------------------------------

### Comparison Implementations

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U444.html

Details on how UInt compares with other types.

```APIDOC
## Cmp<UInt<Ur, B1>> for UInt<Ul, B0>

### Description
Compares `UInt<Ul, B0>` with `UInt<Ur, B1>`. The result is `Less`.

### Method
`cmp`

### Endpoint
N/A (Implementation detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Output** (type) - The result of the comparison. It should only ever be one of `Greater`, `Less`, or `Equal`.

### Response Example
```json
{
  "example": "Less"
}
```

## Cmp<UTerm> for UInt<U, B>

### Description
Compares `UInt<U, B>` with `UTerm`. Indicates that `Nonzero` is greater than `Zero`.

### Method
`cmp`

### Endpoint
N/A (Implementation detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Output** (type) - The result of the comparison. It should only ever be one of `Greater`, `Less`, or `Equal`.

### Response Example
```json
{
  "example": "Greater"
}
```
```

--------------------------------

### UInt Length Implementation

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U46.html

Details how to get the length of a UInt value.

```APIDOC
## impl<U, B: Bit> Len for UInt<U, B>

### Description
Calculates the length of a `UInt<U, B>` value.

### Method
`fn len(&self) -> Self::Output`

### Parameters
- **self** (UInt<U, B>) - The `UInt` value.

### Response
#### Success Response (200)
- **Output** (type) - The length as a type-level unsigned integer.

### Response Example
```json
{
  "Output": "<<U as Len>::Output as Add<B1>>::Output"
}
```
```

--------------------------------

### PInt<U> Implementation Methods

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.P776.html

Methods available for PInt types, including instantiation.

```APIDOC
## pub fn new() -> PInt<U>

### Description
Instantiates a singleton representing this strictly positive integer.

### Parameters
- None

### Returns
- **PInt<U>** - A new instance of the strictly positive integer type.
```

--------------------------------

### Bit and Length Operations

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U184.html

Implementations for getting bits and calculating length.

```APIDOC
## GetBit<UInt<Ui, Bi>> for UInt<Un, Bn>

### Description
Retrieves a specific bit from a `UInt` value.

### Method
`get_bit`

### Endpoint
N/A (Implementation detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Output** (Type) - The value of the requested bit.

### Response Example
```json
{
  "example": "BitValue"
}
```

## GetBit<UTerm> for UInt<Un, Bn>

### Description
Retrieves a specific bit from a `UInt` value when the index is `UTerm`.

### Method
`get_bit`

### Endpoint
N/A (Implementation detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Output** (*Bn*) - The value of the bit at the `UTerm` index.

### Response Example
```json
{
  "example": "B"
}
```

## Len for UInt<U, B>

### Description
Calculates the length of a `UInt` value as a type-level unsigned integer.

### Method
`len`

### Endpoint
N/A (Implementation detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Output** (Type) - The length of the `UInt`.

### Response Example
```json
{
  "example": "LengthType"
}

```

--------------------------------

### Comparison Implementations

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U1000000000000.html

Details on how UInt compares with other types, including specific cases for B0 and B1.

```APIDOC
## Comparison Implementations for UInt

### `impl<Ul, Ur: Unsigned> Cmp<UInt<Ur, B0>> for UInt<Ul, B0>`

Compares `UInt<Ul, B0>` with `UInt<Ur, B0>`.

#### Type `Output`
- Type: `<Ul as PrivateCmp<Ur, Equal>>::Output`
- Description: The result of the comparison. It should only ever be one of `Greater`, `Less`, or `Equal`.

### `impl<Ul, Ur: Unsigned> Cmp<UInt<Ur, B1>> for UInt<Ul, B0>`

Compares `UInt<Ul, B0>` with `UInt<Ur, B1>`.

#### Type `Output`
- Type: `<Ul as PrivateCmp<Ur, Less>>::Output`
- Description: The result of the comparison. It should only ever be one of `Greater`, `Less`, or `Equal`.

### `impl<U: Unsigned, B: Bit> Cmp<UTerm> for UInt<U, B>`

Compares `UInt<U, B>` with `UTerm` (Nonzero > Zero).

#### Type `Output`
- Type: `Greater`
- Description: The result of the comparison. It should only ever be one of `Greater`, `Less`, or `Equal`.
```

--------------------------------

### PowerOfTwo Trait Examples

Source: https://docs.rs/typenum/1.19.0/typenum/marker_traits/trait.PowerOfTwo.html

Illustrates the usage and compile-time constraints of the PowerOfTwo trait.

```APIDOC
## §Examples

Here’s a working example:

```rust
use typenum::{PowerOfTwo, P4, P8};

fn only_p2<P: PowerOfTwo>() {}

only_p2::<P4>();
only_p2::<P8>();
```

Numbers which are not a power of two will fail to compile in this example:

ⓘ```rust
use typenum::{P9, P511, P1023, PowerOfTwo};

fn only_p2<P: PowerOfTwo>() { }

only_p2::<P9>();
only_p2::<P511>();
only_p2::<P1023>();
```
```

--------------------------------

### PInt<U> Implementations

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.P410.html

Provides documentation for various implementations of the PInt<U> struct, covering arithmetic operations, comparisons, and formatting.

```APIDOC
## Implementations for PInt<U>

### `impl<U: Unsigned + NonZero> PInt<U>`

#### `pub fn new() -> PInt<U>`
Instantiates a singleton representing this strictly positive integer.

### `impl<U: Unsigned + NonZero> Abs for PInt<U>`

#### `type Output = PInt<U>`
The absolute value.

### `impl<Ul, Ur: Unsigned + NonZero> Add<NInt<Ur>> for PInt<Ul>`

#### `type Output = <Ul as PrivateIntegerAdd<<Ul as Cmp<Ur>>::Output, Ur>>::Output`
The resulting type after applying the `+` operator.

#### `fn add(self, rhs: NInt<Ur>) -> Self::Output`
Performs the `+` operation.

### `impl<Ul, Ur: Unsigned + NonZero> Add<PInt<Ur>> for PInt<Ul>`

#### `type Output = PInt<<Ul as Add<Ur>>::Output>`
The resulting type after applying the `+` operator.

#### `fn add(self, _: PInt<Ur>) -> Self::Output`
Performs the `+` operation.

### `impl<U: Unsigned + NonZero> Add<Z0> for PInt<U>`

#### `type Output = PInt<U>`
The resulting type after applying the `+` operator.

#### `fn add(self, _: Z0) -> Self::Output`
Performs the `+` operation.

### `impl<U: Unsigned + NonZero + Binary> Binary for PInt<U>`

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result`
Formats the value using the given formatter.

### `impl<U: Clone + Unsigned + NonZero> Clone for PInt<U>`

#### `fn clone(&self) -> PInt<U>`
Returns a duplicate of the value.

#### `fn clone_from(&mut self, source: &Self)`
Performs copy-assignment from `source`.

### `impl<P: Unsigned + NonZero, N: Unsigned + NonZero> Cmp<NInt<N>> for PInt<P>`

#### `type Output = Greater`
The result of the comparison. It should only ever be one of `Greater`, `Less`, or `Equal`.

### `impl<Pl: Cmp<Pr> + Unsigned + NonZero, Pr: Unsigned + NonZero> Cmp<PInt<Pr>> for PInt<Pl>`

#### `type Output = <Pl as Cmp<Pr>>::Output`
The result of the comparison. It should only ever be one of `Greater`, `Less`, or `Equal`.

### `impl<U: Unsigned + NonZero> Cmp<Z0> for PInt<U>`

#### `type Output = Greater`
The result of the comparison. It should only ever be one of `Greater`, `Less`, or `Equal`.

### `impl<U: Debug + Unsigned + NonZero> Debug for PInt<U>`

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result`
Formats the value using the given formatter.

### `impl<U: Default + Unsigned + NonZero> Default for PInt<U>`

#### `fn default() -> PInt<U>`
Returns the “default value” for a type.

### `impl<Ul, Ur: Unsigned + NonZero> Div<NInt<Ur>> for PInt<Ul>`

#### `type Output = <PInt<Ul> as PrivateDivInt<<Ul as Cmp<Ur>>::Output, NInt<Ur>>>::Output`
The resulting type after applying the `/` operator.

#### `fn div(self, rhs: NInt<Ur>) -> Self::Output`
Performs the `/` operation.

### `impl<Ul, Ur: Unsigned + NonZero> Div<PInt<Ur>> for PInt<Ul>`

#### `type Output = <PInt<Ul> as PrivateDivInt<<Ul as Cmp<Ur>>::Output, PInt<Ur>>>::Output`
The resulting type after applying the `/` operator.

#### `fn div(self, rhs: PInt<Ur>) -> Self::Output`
Performs the `/` operation.

### `impl<U1, U2> Gcd<NInt<U2>> for PInt<U1>`

#### `type Output = PInt<<U1 as Gcd<U2>>::Output>`
The greatest common divisor.

### `impl<U1, U2> Gcd<PInt<U2>> for PInt<U1>`

#### `type Output = PInt<<U1 as Gcd<U2>>::Output>`
The greatest common divisor.

### `impl<U> Gcd<Z0> for PInt<U>`

#### `type Output = PInt<U>`
The greatest common divisor.

### `impl<U: Hash + Unsigned + NonZero> Hash for PInt<U>`

#### `fn hash<__H: Hasher>(&self, state: &mut __H)`
Feeds this value into the given `Hasher`.

#### `fn hash_slice<H>(data: &[Self], state: &mut H)`
Feeds a slice of this type into the given `Hasher`.
```

--------------------------------

### PInt<U> Instantiation

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.P137438953471.html

The new method allows for the instantiation of a singleton representing the strictly positive integer.

```APIDOC
## fn new()

### Description
Instantiates a singleton representing this strictly positive integer.

### Method
Static Method

### Response
- **PInt<U>** - A new instance of the strictly positive integer type.
```

--------------------------------

### GetBit Trait Implementations for UTerm

Source: https://docs.rs/typenum/1.19.0/typenum/uint/struct.UTerm.html

Details how to get a specific bit from UTerm.

```APIDOC
## GetBit Trait Implementations for UTerm

### impl<I> GetBit<I> for UTerm

#### Type Output
```rust
type Output = B0
```

### impl<Un, Bn> GetBit<UTerm> for UInt<Un, Bn>
where Bn: Copy,

#### Type Output
```rust
type Output = Bn
```
```

--------------------------------

### Bit Manipulation

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U9223372036854775808.html

Provides functionality to get specific bits from `UInt` types.

```APIDOC
### impl<Un, Bn, Ui, Bi> GetBit<UInt<Ui, Bi>> for UInt<Un, Bn>

#### type Output = <Un as GetBit<<UInt<Ui, Bi> as Sub<B1>>::Output>>::Output

### Description
Retrieves a specific bit from a `UInt` type when the index is also a `UInt`.

### impl<Un, Bn> GetBit<UTerm> for UInt<Un, Bn>

#### type Output = Bn

### Description
Retrieves the bit at the `UTerm` index (effectively the least significant bit).
```

--------------------------------

### Max, Min, and Ord Implementations

Source: https://docs.rs/typenum/1.19.0/typenum/consts/type.U688.html

Implementations for finding the maximum, minimum, and ordering of UInt.

```APIDOC
## Max<Ur> for UInt<U, B>

### Description
Implements the `Max` trait to find the maximum between `UInt<U, B>` and `Ur`.

### Method
`max`

### Endpoint
N/A (Implementation detail)

### Parameters
- **rhs** (Ur) - The right-hand side operand.

### Request Body
None

### Response
#### Success Response (200)
- **Output** (type) - The type of the maximum of `Self` and `Rhs`.

### Response Example
```json
{
  "example": "<UInt<U, B> as PrivateMax<Ur, <UInt<U, B> as Cmp<Ur>>::Output>>::Output"
}
```

## Min<Ur> for UInt<U, B>

### Description
Implements the `Min` trait to find the minimum between `UInt<U, B>` and `Ur`.

### Method
`min`

### Endpoint
N/A (Implementation detail)

### Parameters
- **rhs** (Ur) - The right-hand side operand.

### Request Body
None

### Response
#### Success Response (200)
- **Output** (type) - The type of the minimum of `Self` and `Rhs`.

### Response Example
```json
{
  "example": "<UInt<U, B> as PrivateMin<Ur, <UInt<U, B> as Cmp<Ur>>::Output>>::Output"
}
```

## Ord for UInt<U, B>

### Description
Implements the `Ord` trait for `UInt<U, B>`.

### Method
Comparison operators (e.g., `<`, `>`, `<=`, `>=`)

### Endpoint
N/A (Implementation detail)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Result** (bool) - The result of the ordering comparison.
```
Tokens:
Raw