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

use crate::bint::doc;

macro_rules! impl_desc {
    () => {
        doc::arithmetic_impl_desc!("Overflowing", "overflowing", "Each method returns a tuple of type `(Self, bool)` where the first item of the tuple is the result of the calculation truncated to the number of bits of `self`, and the second item is a boolean which indicates whether overflow occurred (i.e. if the number of bits of the result of the calculation exceeded the number of bits of `self`).")
    };
}

pub(crate) use impl_desc;

doc::doc_comment_impl!(
    overflowing_abs,
    overflowing_add,
    overflowing_add_signed,
    overflowing_add_unsigned,
    overflowing_div,
    overflowing_div_euclid,
    overflowing_mul,
    overflowing_neg,
    overflowing_pow,
    overflowing_rem,
    overflowing_rem_euclid,
    overflowing_shl,
    overflowing_shr,
    overflowing_sub,
    overflowing_sub_unsigned
);

macro_rules! overflowing_mul_digit {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "Calculates the multiplication of self and [`prim@u64`] rhs.\n\n"
            "Returns a tuple of the multiplication along with a boolean indicating whether an arithmetic overflow would occur.\n"
            "If an overflow would have occurred then the wrapped value is returned."
        }
    };
}

pub(crate) use overflowing_mul_digit;