positive 0.5.0

A type-safe wrapper for guaranteed positive decimal values
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223

/******************************************************************************
   Author: Joaquín Béjar García
   Email: jb@taunais.com
   Date: 25/12/25
******************************************************************************/

//! Predefined constant values for the `Positive` type.
//!
//! This module provides commonly used numeric constants as `Positive` values,
//! including integers, mathematical constants, and special values.
//!
//! # Compile-time evaluation
//!
//! Every `pub const` in this module is built from:
//!
//! 1. `rust_decimal_macros::dec!(...)` literals — expanded at compile
//!    time into `Decimal` associated constants with no runtime cost.
//! 2. `Decimal::ZERO` / `Decimal::ONE` / `Decimal::TWO` / `Decimal::TEN`
//!    / `Decimal::MAX` — `const` items in `rust_decimal` itself.
//! 3. `Positive::from_decimal_const(...)` — a `pub(crate) const fn`
//!    crate-private wrapper that stores the value without revalidation
//!    (safety upheld by the literal being non-negative).
//!
//! None of these involve runtime work, allocations, `OnceCell`,
//! `lazy_static`, or floating-point conversion. Consumers can treat
//! every constant as zero-cost at the point of use.

use crate::Positive;
use rust_decimal::Decimal;
use rust_decimal_macros::dec;

// =============================================================================
// Integer Constants (0-10)
// =============================================================================

/// A zero value represented as a `Positive` value.
///
/// This constant is not available when the `non-zero` feature is enabled.
#[cfg(not(feature = "non-zero"))]
pub const ZERO: Positive = Positive::from_decimal_const(Decimal::ZERO);

/// A value of one represented as a `Positive` value.
pub const ONE: Positive = Positive::from_decimal_const(Decimal::ONE);

/// A value of two represented as a `Positive` value.
pub const TWO: Positive = Positive::from_decimal_const(Decimal::TWO);

/// A value of three represented as a `Positive` value.
pub const THREE: Positive = Positive::from_decimal_const(dec!(3));

/// A value of four represented as a `Positive` value.
pub const FOUR: Positive = Positive::from_decimal_const(dec!(4));

/// A value of five represented as a `Positive` value.
pub const FIVE: Positive = Positive::from_decimal_const(dec!(5));

/// A value of six represented as a `Positive` value.
pub const SIX: Positive = Positive::from_decimal_const(dec!(6));

/// A value of seven represented as a `Positive` value.
pub const SEVEN: Positive = Positive::from_decimal_const(dec!(7));

/// A value of eight represented as a `Positive` value.
pub const EIGHT: Positive = Positive::from_decimal_const(dec!(8));

/// A value of nine represented as a `Positive` value.
pub const NINE: Positive = Positive::from_decimal_const(dec!(9));

/// A value of ten represented as a `Positive` value.
pub const TEN: Positive = Positive::from_decimal_const(Decimal::TEN);

// =============================================================================
// Multiples of 5 (15-95)
// =============================================================================

/// A value of fifteen represented as a `Positive` value.
pub const FIFTEEN: Positive = Positive::from_decimal_const(dec!(15));

/// A value of twenty represented as a `Positive` value.
pub const TWENTY: Positive = Positive::from_decimal_const(dec!(20));

/// A value of twenty-five represented as a `Positive` value.
pub const TWENTY_FIVE: Positive = Positive::from_decimal_const(dec!(25));

/// A value of thirty represented as a `Positive` value.
pub const THIRTY: Positive = Positive::from_decimal_const(dec!(30));

/// A value of thirty-five represented as a `Positive` value.
pub const THIRTY_FIVE: Positive = Positive::from_decimal_const(dec!(35));

/// A value of forty represented as a `Positive` value.
pub const FORTY: Positive = Positive::from_decimal_const(dec!(40));

/// A value of forty-five represented as a `Positive` value.
pub const FORTY_FIVE: Positive = Positive::from_decimal_const(dec!(45));

/// A value of fifty represented as a `Positive` value.
pub const FIFTY: Positive = Positive::from_decimal_const(dec!(50));

/// A value of fifty-five represented as a `Positive` value.
pub const FIFTY_FIVE: Positive = Positive::from_decimal_const(dec!(55));

/// A value of sixty represented as a `Positive` value.
pub const SIXTY: Positive = Positive::from_decimal_const(dec!(60));

/// A value of sixty-five represented as a `Positive` value.
pub const SIXTY_FIVE: Positive = Positive::from_decimal_const(dec!(65));

/// A value of seventy represented as a `Positive` value.
pub const SEVENTY: Positive = Positive::from_decimal_const(dec!(70));

/// A value of seventy-five represented as a `Positive` value.
pub const SEVENTY_FIVE: Positive = Positive::from_decimal_const(dec!(75));

/// A value of eighty represented as a `Positive` value.
pub const EIGHTY: Positive = Positive::from_decimal_const(dec!(80));

/// A value of eighty-five represented as a `Positive` value.
pub const EIGHTY_FIVE: Positive = Positive::from_decimal_const(dec!(85));

/// A value of ninety represented as a `Positive` value.
pub const NINETY: Positive = Positive::from_decimal_const(dec!(90));

/// A value of ninety-five represented as a `Positive` value.
pub const NINETY_FIVE: Positive = Positive::from_decimal_const(dec!(95));

// =============================================================================
// Multiples of 100 (100-900)
// =============================================================================

/// A value of one hundred represented as a `Positive` value.
pub const HUNDRED: Positive = Positive::from_decimal_const(Decimal::ONE_HUNDRED);

/// A value of two hundred represented as a `Positive` value.
pub const TWO_HUNDRED: Positive = Positive::from_decimal_const(dec!(200));

/// A value of three hundred represented as a `Positive` value.
pub const THREE_HUNDRED: Positive = Positive::from_decimal_const(dec!(300));

/// A value of four hundred represented as a `Positive` value.
pub const FOUR_HUNDRED: Positive = Positive::from_decimal_const(dec!(400));

/// A value of five hundred represented as a `Positive` value.
pub const FIVE_HUNDRED: Positive = Positive::from_decimal_const(dec!(500));

/// A value of six hundred represented as a `Positive` value.
pub const SIX_HUNDRED: Positive = Positive::from_decimal_const(dec!(600));

/// A value of seven hundred represented as a `Positive` value.
pub const SEVEN_HUNDRED: Positive = Positive::from_decimal_const(dec!(700));

/// A value of eight hundred represented as a `Positive` value.
pub const EIGHT_HUNDRED: Positive = Positive::from_decimal_const(dec!(800));

/// A value of nine hundred represented as a `Positive` value.
pub const NINE_HUNDRED: Positive = Positive::from_decimal_const(dec!(900));

// =============================================================================
// Multiples of 1000 (1000-10000)
// =============================================================================

/// A value of one thousand represented as a `Positive` value.
pub const THOUSAND: Positive = Positive::from_decimal_const(Decimal::ONE_THOUSAND);

/// A value of two thousand represented as a `Positive` value.
pub const TWO_THOUSAND: Positive = Positive::from_decimal_const(dec!(2000));

/// A value of three thousand represented as a `Positive` value.
pub const THREE_THOUSAND: Positive = Positive::from_decimal_const(dec!(3000));

/// A value of four thousand represented as a `Positive` value.
pub const FOUR_THOUSAND: Positive = Positive::from_decimal_const(dec!(4000));

/// A value of five thousand represented as a `Positive` value.
pub const FIVE_THOUSAND: Positive = Positive::from_decimal_const(dec!(5000));

/// A value of six thousand represented as a `Positive` value.
pub const SIX_THOUSAND: Positive = Positive::from_decimal_const(dec!(6000));

/// A value of seven thousand represented as a `Positive` value.
pub const SEVEN_THOUSAND: Positive = Positive::from_decimal_const(dec!(7000));

/// A value of eight thousand represented as a `Positive` value.
pub const EIGHT_THOUSAND: Positive = Positive::from_decimal_const(dec!(8000));

/// A value of nine thousand represented as a `Positive` value.
pub const NINE_THOUSAND: Positive = Positive::from_decimal_const(dec!(9000));

/// A value of ten thousand represented as a `Positive` value.
pub const TEN_THOUSAND: Positive = Positive::from_decimal_const(dec!(10000));

// =============================================================================
// Mathematical Constants
// =============================================================================

/// The mathematical constant π (pi) represented as a `Positive` value.
/// Approximately 3.14159265358979323846.
pub const PI: Positive = Positive::from_decimal_const(Decimal::PI);

/// The mathematical constant e (Euler's number) represented as a `Positive` value.
/// Approximately 2.71828182845904523536.
pub const E: Positive = Positive::from_decimal_const(Decimal::E);

// =============================================================================
// Special Values
// =============================================================================

/// Default epsilon value for approximate comparisons.
/// Used for floating-point tolerance in equality checks.
pub const EPSILON: Decimal = dec!(1e-16);

/// Tolerance for `Positive == Decimal` comparisons.
///
/// Precomputed as `EPSILON * 100` (= `1e-14`). Declaring it as a `const`
/// avoids the `Decimal::from(100)` construction and multiplication on
/// every `PartialEq<Decimal>` call.
pub const EPSILON_CMP: Decimal = dec!(1e-14);

/// Represents the maximum positive value possible (effectively infinity).
pub const INFINITY: Positive = Positive::from_decimal_const(Decimal::MAX);

/// Number of days in a year.
pub const DAYS_IN_A_YEAR: Positive = Positive::from_decimal_const(dec!(365.0));