anyint 0.1.0

provides traits and structs for working with integers of any bit size
Documentation 
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

#![cfg_attr(not(feature = "std"), no_std)]
#![deny(missing_docs, unused_features)]
#![feature(
    test,
    decl_macro,
    const_trait_impl,
    associated_type_defaults,
    result_flattening
)]

//! Anyint provides traits and structs for working with integers of any bit size

extern crate self as anyint;

/// Restrict and contrain values.
pub mod clamp;

/// Conversion types intented to be used with [`int`].
pub mod convert;

/// Struct implementation for [`NonStandardInteger`](non_standard_integer::NonStandardInteger)
pub mod integer;

/// Traits for implementing a non standard integer.
pub mod non_standard_integer;

/// Error types relating to integers.
pub mod error;

pub mod macros;

/// Implementations of traits from the [`num-traits`] crate
#[cfg(feature = "num_traits")]
mod num_traits;

mod ops;

#[cfg(test)]
mod bench;

/// The purpose of this module is to alleviate imports of many common [`int`] traits.
///
/// ```
/// use anyint::prelude::*;
///
/// let x: int<u8, 6> = int::new(20);
/// assert_eq!(x.value(), 20);
///
/// let y: int<i8, 6> = int::from_wrapping(34);
/// assert_eq!(y.value(), -30);
/// ```
pub mod prelude {
    // todo: no std
    // todo: unstable feature flags
    pub use super::convert::*;
    pub use super::integer::int;
    pub use super::non_standard_integer::*;
}

pub use integer::int;

// tests

#[cfg(doctest)]
mod test_readme {
    #[doc = include_str!("../../README.md")]
    extern "C" {}
}