arranged 0.1.2

Statically bounds-checked (machine-word-abstracting? TBD) ranged types as zero or low-runtime overhead abstractions providing safe (no unintentional overflow) arithmetic.
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194

use super::*;
use assert2::assert;

type Range<const START: i64, const END: i64> = RiI64<START, END>;

#[test]
const fn const_range_contains_in_bounds_value() {
    // Given
    const LARGEST_NATIONAL_DEBT_AS_ASSET: i64 = -30_000_000_000_000;
    const SMALLEST_NATIONAL_DEBT_AS_ASSET: i64 = 0;

    type Sut = Range<LARGEST_NATIONAL_DEBT_AS_ASSET, SMALLEST_NATIONAL_DEBT_AS_ASSET>;

    const CANADA: i64 = -2_217_490_000_000;
    const EXPECTED: bool = true;

    // When
    const RESULT: bool = Sut::contains(&CANADA);

    // Then
    // Uncomment below and set `assert` to failing condition to observe compile-time impact
    // const _ASSERT: () = std::assert!(RESULT == EXPECTED);
    std::assert!(RESULT == EXPECTED);
}

#[test]
const fn const_range_contains_min_bounds_value() {
    // Given
    const LARGEST_NATIONAL_DEBT_AS_ASSET: i64 = -30_000_000_000_000;
    const SMALLEST_NATIONAL_DEBT_AS_ASSET: i64 = 0;

    type Sut = Range<LARGEST_NATIONAL_DEBT_AS_ASSET, SMALLEST_NATIONAL_DEBT_AS_ASSET>;

    const US: i64 = -30_000_000_000_000;
    const EXPECTED: bool = true;

    // When
    const RESULT: bool = Sut::contains(&US);

    // Then
    // Uncomment below and set `assert` to failing condition to observe compile-time impact
    // const _ASSERT: () = std::assert!(RESULT == EXPECTED);
    std::assert!(RESULT == EXPECTED);
}

#[test]
const fn const_range_contains_max_bounds_value() {
    // Given
    const LARGEST_NATIONAL_DEBT_AS_ASSET: i64 = -30_000_000_000_000;
    const SMALLEST_NATIONAL_DEBT_AS_ASSET: i64 = 0;

    type Sut = Range<LARGEST_NATIONAL_DEBT_AS_ASSET, SMALLEST_NATIONAL_DEBT_AS_ASSET>;

    const WALLIS_AND_FUTUNA: i64 = 0;
    const EXPECTED: bool = true;

    // When
    const RESULT: bool = Sut::contains(&WALLIS_AND_FUTUNA);

    // Then
    // Uncomment below and set `assert` to failing condition to observe compile-time impact
    // const _ASSERT: () = std::assert!(RESULT == EXPECTED);
    std::assert!(RESULT == EXPECTED);
}

#[test]
const fn const_range_does_not_contain_low_out_of_bounds_value() {
    // Given
    const LARGEST_NATIONAL_DEBT_AS_ASSET: i64 = -30_000_000_000_000;
    const SMALLEST_NATIONAL_DEBT_AS_ASSET: i64 = 0;

    type Sut = Range<LARGEST_NATIONAL_DEBT_AS_ASSET, SMALLEST_NATIONAL_DEBT_AS_ASSET>;

    const MORE_DEBT_THAN_US: i64 = -100_000_000_000_000;
    const EXPECTED: bool = false;

    // When
    const RESULT: bool = Sut::contains(&MORE_DEBT_THAN_US);

    // Then
    // Uncomment below and set `assert` to failing condition to observe compile-time impact
    // const _ASSERT: () = std::assert!(RESULT == EXPECTED);
    std::assert!(RESULT == EXPECTED);
}

#[test]
const fn const_range_does_not_contain_high_out_of_bounds_value() {
    // Given
    const LARGEST_NATIONAL_DEBT_AS_ASSET: i64 = -30_000_000_000_000;
    const SMALLEST_NATIONAL_DEBT_AS_ASSET: i64 = 0;

    type Sut = Range<LARGEST_NATIONAL_DEBT_AS_ASSET, SMALLEST_NATIONAL_DEBT_AS_ASSET>;

    const LESS_DEBT_THAN_WALLIS_AND_FUTUNA: i64 = 1_000_000_000;
    const EXPECTED: bool = false;

    // When
    const RESULT: bool = Sut::contains(&LESS_DEBT_THAN_WALLIS_AND_FUTUNA);

    // Then
    // Uncomment below and set `assert` to failing condition to observe compile-time impact
    // const _ASSERT: () = std::assert!(RESULT == EXPECTED);
    std::assert!(RESULT == EXPECTED);
}

#[test]
fn range_contains_in_bounds_value() {
    // Given
    const LARGEST_NATIONAL_DEBT_AS_ASSET: i64 = -30_000_000_000_000;
    const SMALLEST_NATIONAL_DEBT_AS_ASSET: i64 = 0;

    type Sut = Range<LARGEST_NATIONAL_DEBT_AS_ASSET, SMALLEST_NATIONAL_DEBT_AS_ASSET>;

    let canada = -2_217_490_000_000;
    let expected = true;

    // When
    let result = Sut::contains(&canada);

    // Then
    assert!(result == expected);
}

#[test]
fn range_contains_min_bounds_value() {
    // Given
    const LARGEST_NATIONAL_DEBT_AS_ASSET: i64 = -30_000_000_000_000;
    const SMALLEST_NATIONAL_DEBT_AS_ASSET: i64 = 0;

    type Sut = Range<LARGEST_NATIONAL_DEBT_AS_ASSET, SMALLEST_NATIONAL_DEBT_AS_ASSET>;

    let us = -30_000_000_000_000;
    let expected = true;

    // When
    let result = Sut::contains(&us);

    // Then
    assert!(result == expected);
}

#[test]
fn range_contains_max_bounds_value() {
    // Given
    const LARGEST_NATIONAL_DEBT_AS_ASSET: i64 = -30_000_000_000_000;
    const SMALLEST_NATIONAL_DEBT_AS_ASSET: i64 = 0;

    type Sut = Range<LARGEST_NATIONAL_DEBT_AS_ASSET, SMALLEST_NATIONAL_DEBT_AS_ASSET>;

    let wallis_and_futuna = 0;
    let expected = true;

    // When
    let result = Sut::contains(&wallis_and_futuna);

    // Then
    assert!(result == expected);
}

#[test]
fn range_does_not_contain_low_out_of_bounds_value() {
    // Given
    const LARGEST_NATIONAL_DEBT_AS_ASSET: i64 = -30_000_000_000_000;
    const SMALLEST_NATIONAL_DEBT_AS_ASSET: i64 = 0;

    type Sut = Range<LARGEST_NATIONAL_DEBT_AS_ASSET, SMALLEST_NATIONAL_DEBT_AS_ASSET>;

    let more_debt_than_us = -100_000_000_000_000;
    let expected = false;

    // When
    let result = Sut::contains(&more_debt_than_us);

    // Then
    assert!(result == expected);
}

#[test]
fn range_does_not_contain_high_out_of_bounds_value() {
    // Given
    const LARGEST_NATIONAL_DEBT_AS_ASSET: i64 = -30_000_000_000_000;
    const SMALLEST_NATIONAL_DEBT_AS_ASSET: i64 = 0;

    type Sut = Range<LARGEST_NATIONAL_DEBT_AS_ASSET, SMALLEST_NATIONAL_DEBT_AS_ASSET>;

    let less_debt_than_wallis_and_futuna: i64 = 1_000_000;
    let expected = false;

    // When
    let result = Sut::contains(&less_debt_than_wallis_and_futuna);

    // Then
    assert!(result == expected);
}