      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135

    //! This crate provides type-level numbers evaluated at compile time. It depends only on libcore.
    //!
    //! The traits defined or used in this crate are used in a typical manner. They can be divided into
    //! two categories: **marker traits** and **type operators**.
    //!
    //! Many of the marker traits have functions defined, but they all do essentially the same thing:
    //! convert a type into its runtime counterpart, and are really just there for debugging. For
    //! example,
    //!
    //! ```rust
    //! use typenum::{N4, Integer};
    //!
    //! assert_eq!(N4::to_i32(), -4);
    //! ```
    //!
    //! **Type operators** are traits that behave as functions at the type level. These are the meat of
    //! this library. Where possible, traits defined in libcore have been used, but their attached
    //! functions have not been implemented.
    //!
    //! For example, the `Add` trait is implemented for both unsigned and signed integers, but the
    //! `add` function is not. As there are never any objects of the types defined here, it wouldn't
    //! make sense to implement it. What is important is its associated type `Output`, which is where
    //! the addition happens.
    //!
    //! ```rust
    //! use std::ops::Add;
    //! use typenum::{Integer, P3, P4};
    //!
    //! type X = <P3 as Add<P4>>::Output;
    //! assert_eq!(<X as Integer>::to_i32(), 7);
    //! ```
    //!
    //! In addition, helper aliases are defined for type operators. For example, the above snippet
    //! could be replaced with
    //!
    //! ```rust
    //! use typenum::{Sum, Integer, P3, P4};
    //!
    //! type X = Sum<P3, P4>;
    //! assert_eq!(<X as Integer>::to_i32(), 7);
    //! ```
    //!
    //! Documented in each module is the full list of type operators implemented.
    //!

    #![no_std]
    #![warn(missing_docs)]
    #![cfg_attr(feature = "i128", feature(i128_type))]
    #![cfg_attr(feature = "strict", deny(missing_docs))]
    #![cfg_attr(feature = "strict", deny(warnings))]
    #![cfg_attr(feature = "cargo-clippy", deny(clippy))]
    #![cfg_attr(feature = "cargo-clippy",
                allow(type_complexity, len_without_is_empty, new_without_default_derive))]

    // For debugging macros:
    // #![feature(trace_macros)]
    // trace_macros!(true);

    use core::cmp::Ordering;

    include!(concat!(env!("OUT_DIR"), "/consts.rs"));
    include!(concat!(env!("OUT_DIR"), "/op.rs"));
    pub mod bit;
    pub mod uint;
    pub mod int;
    pub mod private;
    pub mod marker_traits;
    pub mod type_operators;
    pub mod operator_aliases;

    pub mod array;

    pub use consts::*;
    pub use marker_traits::*;
    pub use type_operators::*;
    pub use operator_aliases::*;

    pub use uint::{UInt, UTerm};
    pub use int::{NInt, PInt};
    pub use array::{ATerm, TArr};

    /// A potential output from `Cmp`, this is the type equivalent to the enum variant
    /// `core::cmp::Ordering::Greater`.
    #[derive(Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Hash, Debug, Default)]
    pub struct Greater;

    /// A potential output from `Cmp`, this is the type equivalent to the enum variant
    /// `core::cmp::Ordering::Less`.
    #[derive(Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Hash, Debug, Default)]
    pub struct Less;

    /// A potential output from `Cmp`, this is the type equivalent to the enum variant
    /// `core::cmp::Ordering::Equal`.
    #[derive(Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Hash, Debug, Default)]
    pub struct Equal;

    /// Returns `core::cmp::Ordering::Greater`
    impl Ord for Greater {
        #[inline]
        fn to_ordering() -> Ordering {
            Ordering::Greater
        }
    }

    /// Returns `core::cmp::Ordering::Less`
    impl Ord for Less {
        #[inline]
        fn to_ordering() -> Ordering {
            Ordering::Less
        }
    }

    /// Returns `core::cmp::Ordering::Equal`
    impl Ord for Equal {
        #[inline]
        fn to_ordering() -> Ordering {
            Ordering::Equal
        }
    }

    /// Asserts that two types are the same.
    #[macro_export]
    macro_rules! assert_type_eq {
        ($a:ty, $b:ty) => (
            let _: <$a as $crate::Same<$b>>::Output;
        );
    }

    /// Asserts that a type is `True`, aka `B1`.
    #[macro_export]
    macro_rules! assert_type {
        ($a:ty) => (
            let _: <$a as $crate::Same<True>>::Output;
        );
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)