fastnum 0.7.4

Fast decimal numbers library
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
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

pub(crate) mod bits;
pub(crate) mod carrying;
pub(crate) mod cast;
pub(crate) mod checked;
pub(crate) mod cmp;
pub(crate) mod consts;
pub(crate) mod convert;
pub(crate) mod endian;
pub(crate) mod impls;
pub(crate) mod num;
pub(crate) mod overflowing;
pub(crate) mod saturating;
pub(crate) mod strict;
pub(crate) mod widening;
pub(crate) mod wrapping;

pub(crate) use crate::doc::*;

macro_rules! int_type_doc {
    ($bits: literal, $sign: literal) => {
        concat!($bits, "-bit ", $sign, " integer type.")
    };
}

pub(crate) use int_type_doc;

macro_rules! type_str {
    ($sign: ident $bits: literal) => {
        concat!(stringify!($sign), $bits)
    };
}

pub(crate) use type_str;

macro_rules! link_type_str {
    ($sign: ident $bits: literal) => {
        concat!("[`", doc::type_str!($sign $bits), "`](crate::", doc::type_str!($sign $bits), ")")
    };
}

pub(crate) use link_type_str;

macro_rules! m {
    ($sign: ident $bits: literal) => {
        concat!(doc::small_sign!($sign), $bits, "!")
    };
}

pub(crate) use m;

macro_rules! example_header {
    ($sign: ident $bits: literal) => {
        concat!(
"

# Examples

Please note that this example is shared between integer types.
Which explains why ", doc::link_type_str!($sign $bits), " is used here.", "

```
use fastnum::*", ";

"
        )
    }
}

pub(crate) use example_header;

macro_rules! doc_comment {
    { $(# $method: ident, )? $sign: ident $bits: literal, $($($desc: expr)+)? $(, $($code: expr)+)? } => {
        concat!(
            $($($desc), +,)?
            $("\n\n", "See also: <https://doc.rust-lang.org/std/primitive.", doc::small_sign!($sign), "64.html#method.", stringify!($method), ">.", )?
            $(
                doc::example_header!($sign $bits),
                $($code), +,
                "\n```"
            )?
        )
    }
}

pub(crate) use doc_comment;

macro_rules! doc_comment_impl {
    ($($name: ident), *) => {
        $(
            macro_rules! $name {
                ($sign: ident $bits: literal) => {
                    doc::doc_comment! {
                        #$name,
                        $sign $bits,
                    }
                };
            }

            pub(crate) use $name;
        )*
    }
}

pub(crate) use doc_comment_impl;

macro_rules! arithmetic_impl_desc {
    ($name: literal, $method: literal, $rest: literal) => {
        concat!(
            $name,
            " arithmetic methods which act on `self`: `self.",
            $method,
            "_...`. ",
            $rest
        )
    };
}

pub(crate) use arithmetic_impl_desc;