use std::{
iter::Sum,
ops::{Add, AddAssign, Div, Mul, Sub, SubAssign},
};
use derive_more::Deref;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use vecdb::{CheckedSub, Formattable, Pco, unlikely};
use super::{CentsSats, Dollars, Sats, StoredF64};
#[derive(
Debug,
Default,
Deref,
Clone,
Copy,
PartialEq,
Eq,
PartialOrd,
Ord,
Hash,
Serialize,
Deserialize,
Pco,
JsonSchema,
)]
pub struct Cents(u64);
impl Cents {
pub const ZERO: Self = Self(0);
pub const MAX_FINITE: Self = Self(u64::MAX - 1);
pub const NAN: Self = Self(u64::MAX);
pub const MAX: Self = Self::NAN;
#[inline]
pub const fn new(value: u64) -> Self {
assert!(value != u64::MAX, "u64::MAX is reserved as Cents::NAN");
Self(value)
}
#[inline]
pub const fn is_nan(self) -> bool {
self.0 == u64::MAX
}
#[inline]
pub const fn finite_inner(self) -> Option<u64> {
if self.is_nan() { None } else { Some(self.0) }
}
#[inline]
pub const fn inner(self) -> u64 {
match self.finite_inner() {
Some(value) => value,
None => panic!("Cents::NAN has no finite integer representation"),
}
}
#[inline]
pub const fn as_u128(self) -> u128 {
self.inner() as u128
}
#[inline]
fn checked_finite(value: Option<u64>) -> Option<Self> {
match value {
Some(u64::MAX) | None => None,
Some(value) => Some(Self(value)),
}
}
#[inline]
fn from_finite_u128(value: u128) -> Self {
assert!(
value < u64::MAX as u128,
"u128 overflow or Cents::NAN sentinel collision"
);
Self(value as u64)
}
#[inline]
pub fn checked_sub(self, rhs: Self) -> Option<Self> {
if unlikely(self.is_nan() || rhs.is_nan()) {
Some(Self::NAN)
} else {
self.0.checked_sub(rhs.0).map(Self)
}
}
#[inline]
pub fn saturating_sub(self, rhs: Self) -> Self {
if unlikely(self.is_nan() || rhs.is_nan()) {
Self::NAN
} else {
Self(self.0.saturating_sub(rhs.0))
}
}
#[inline]
pub fn checked_add(self, rhs: Self) -> Option<Self> {
if unlikely(self.is_nan() || rhs.is_nan()) {
Some(Self::NAN)
} else {
Self::checked_finite(self.0.checked_add(rhs.0))
}
}
pub fn to_dollars(self) -> Dollars {
if unlikely(self.is_nan()) {
Dollars::NAN
} else {
Dollars::from(self.0 as f64 / 100.0)
}
}
pub fn round_to(self, digits: i32) -> Self {
if unlikely(self.is_nan()) {
return Self::NAN;
}
let v = self.0;
let ilog10 = v.checked_ilog10().unwrap_or(0) as i32;
if ilog10 >= digits {
let log_diff = ilog10 - digits + 1;
let pow = 10u128.pow(log_diff as u32);
Self::from_finite_u128(((v as u128 + pow / 2) / pow) * pow)
} else {
self
}
}
#[inline]
pub fn round_to_dollar(self, digits: i32) -> Self {
if unlikely(self.is_nan()) {
return Self::NAN;
}
let dollars = (self.0 as u128 + 50) / 100;
let ilog10 = dollars.checked_ilog10().unwrap_or(0) as i32;
let rounded_dollars = if ilog10 >= digits {
let log_diff = ilog10 - digits + 1;
let pow = 10u128.pow(log_diff as u32);
((dollars + pow / 2) / pow) * pow
} else {
dollars
};
Self::from_finite_u128(rounded_dollars * 100)
}
}
impl From<Dollars> for Cents {
#[inline]
fn from(value: Dollars) -> Self {
let f = f64::from(value);
if unlikely(!f.is_finite()) {
Self::NAN
} else if f < 0.0 {
Self::ZERO
} else {
let cents = (f * 100.0).round();
if cents >= u64::MAX as f64 {
Self::MAX_FINITE
} else {
Self(cents as u64)
}
}
}
}
impl From<Cents> for Dollars {
#[inline]
fn from(value: Cents) -> Self {
value.to_dollars()
}
}
impl From<u64> for Cents {
#[inline]
fn from(value: u64) -> Self {
Self::new(value)
}
}
impl From<usize> for Cents {
#[inline]
fn from(value: usize) -> Self {
Self::new(u64::try_from(value).expect("usize overflow to Cents"))
}
}
impl From<Cents> for u64 {
#[inline]
fn from(value: Cents) -> Self {
value.inner()
}
}
impl From<u128> for Cents {
#[inline]
fn from(value: u128) -> Self {
Self::from_finite_u128(value)
}
}
impl From<Cents> for u128 {
#[inline]
fn from(value: Cents) -> Self {
value.as_u128()
}
}
impl From<Cents> for f64 {
#[inline]
fn from(value: Cents) -> Self {
if unlikely(value.is_nan()) {
f64::NAN
} else {
value.0 as f64
}
}
}
impl From<f64> for Cents {
#[inline]
fn from(value: f64) -> Self {
if unlikely(!value.is_finite()) {
Self::NAN
} else if value < 0.0 {
Self::ZERO
} else if value >= u64::MAX as f64 {
Self::MAX_FINITE
} else {
Self(value as u64)
}
}
}
impl Add for Cents {
type Output = Self;
#[inline]
fn add(self, rhs: Self) -> Self::Output {
self.checked_add(rhs).expect("Cents overflow")
}
}
impl AddAssign for Cents {
#[inline]
fn add_assign(&mut self, rhs: Self) {
*self = *self + rhs;
}
}
impl Sum for Cents {
fn sum<I: Iterator<Item = Self>>(iter: I) -> Self {
iter.fold(Self::ZERO, |sum, value| sum + value)
}
}
impl Sub for Cents {
type Output = Self;
#[inline]
fn sub(self, rhs: Self) -> Self::Output {
self.checked_sub(rhs).expect("Cents underflow")
}
}
impl SubAssign for Cents {
#[inline]
fn sub_assign(&mut self, rhs: Self) {
*self = *self - rhs;
}
}
impl Mul for Cents {
type Output = Self;
#[inline]
fn mul(self, rhs: Self) -> Self::Output {
if unlikely(self.is_nan() || rhs.is_nan()) {
Self::NAN
} else {
Self::checked_finite(self.0.checked_mul(rhs.0)).expect("Cents overflow")
}
}
}
impl Mul<u64> for Cents {
type Output = Self;
#[inline]
fn mul(self, rhs: u64) -> Self::Output {
if unlikely(self.is_nan()) {
Self::NAN
} else {
Self::checked_finite(self.0.checked_mul(rhs)).expect("Cents overflow")
}
}
}
impl Mul<usize> for Cents {
type Output = Self;
#[inline]
fn mul(self, rhs: usize) -> Self::Output {
if unlikely(self.is_nan()) {
Self::NAN
} else {
let rhs = u64::try_from(rhs).expect("usize overflow to Cents multiplier");
Self::checked_finite(self.0.checked_mul(rhs)).expect("Cents overflow")
}
}
}
impl Mul<StoredF64> for Cents {
type Output = Self;
#[inline]
fn mul(self, rhs: StoredF64) -> Self::Output {
Self::from(f64::from(self) * f64::from(rhs))
}
}
impl Mul<Sats> for Cents {
type Output = CentsSats;
#[inline]
fn mul(self, sats: Sats) -> CentsSats {
CentsSats::new(self.as_u128() * sats.as_u128())
}
}
impl Div<Cents> for Cents {
type Output = Self;
#[inline]
fn div(self, rhs: Self) -> Self::Output {
if unlikely(self.is_nan() || rhs.is_nan()) {
Self::NAN
} else {
Self(self.0 / rhs.0)
}
}
}
impl Div<u64> for Cents {
type Output = Self;
#[inline]
fn div(self, rhs: u64) -> Self::Output {
if unlikely(self.is_nan()) {
Self::NAN
} else {
Self(self.0 / rhs)
}
}
}
impl Div<usize> for Cents {
type Output = Self;
#[inline]
fn div(self, rhs: usize) -> Self::Output {
if unlikely(self.is_nan()) {
Self::NAN
} else {
Self(self.0 / rhs as u64)
}
}
}
impl CheckedSub for Cents {
fn checked_sub(self, rhs: Self) -> Option<Self> {
Cents::checked_sub(self, rhs)
}
}
impl std::fmt::Display for Cents {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut buf = itoa::Buffer::new();
let str = buf.format(self.0);
f.write_str(str)
}
}
impl Formattable for Cents {
#[inline(always)]
fn write_to(&self, buf: &mut Vec<u8>) {
let mut b = itoa::Buffer::new();
buf.extend_from_slice(b.format(self.0).as_bytes());
}
#[inline(always)]
fn fmt_json(&self, buf: &mut Vec<u8>) {
if unlikely(self.is_nan()) {
buf.extend_from_slice(b"null");
} else {
self.write_to(buf);
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn conversions_and_sentinel() {
assert_eq!(Cents::MAX, Cents::NAN);
assert_eq!(Cents::MAX_FINITE.inner(), u64::MAX - 1);
assert!(Cents::NAN.is_nan());
assert_eq!(Cents::NAN.finite_inner(), None);
assert!(f64::from(Dollars::from(Cents::NAN)).is_nan());
assert!(f64::from(Cents::NAN).is_nan());
assert!(Cents::from(Dollars::NAN).is_nan());
assert_eq!(Cents::from(f64::MAX), Cents::MAX_FINITE);
let mut json = Vec::new();
Cents::NAN.fmt_json(&mut json);
assert_eq!(json, b"null");
}
#[test]
fn nan_propagates_through_cents_arithmetic() {
let finite = Cents::new(2);
assert_eq!(Cents::NAN + finite, Cents::NAN);
assert_eq!(Cents::NAN - finite, Cents::NAN);
assert_eq!(Cents::NAN * finite, Cents::NAN);
assert_eq!(Cents::NAN / finite, Cents::NAN);
assert_eq!(Cents::NAN.checked_add(finite), Some(Cents::NAN));
assert_eq!(Cents::NAN.checked_sub(finite), Some(Cents::NAN));
}
#[test]
fn finite_arithmetic_cannot_create_nan() {
assert_eq!(Cents::MAX_FINITE.checked_add(Cents::new(1)), None,);
let exact_sentinel_factor = u64::MAX / 3;
assert!(
std::panic::catch_unwind(|| Cents::new(3) * Cents::new(exact_sentinel_factor)).is_err()
);
}
#[test]
fn raw_integer_access_rejects_nan() {
assert!(std::panic::catch_unwind(|| Cents::NAN.inner()).is_err());
assert!(std::panic::catch_unwind(|| Cents::NAN.as_u128()).is_err());
assert!(std::panic::catch_unwind(|| u64::from(Cents::NAN)).is_err());
}
}