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 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
use crate::{
decode::Decode,
encode::{Encode, IsNull},
error::BoxDynError,
types::Type,
{PgArgumentBuffer, PgHasArrayType, PgTypeInfo, PgValueFormat, PgValueRef, Postgres},
};
use byteorder::{BigEndian, ByteOrder};
use std::{
io,
ops::{Add, AddAssign, Sub, SubAssign},
};
/// The PostgreSQL [`MONEY`] type stores a currency amount with a fixed fractional
/// precision. The fractional precision is determined by the database's
/// `lc_monetary` setting.
///
/// Data is read and written as 64-bit signed integers, and conversion into a
/// decimal should be done using the right precision.
///
/// Reading `MONEY` value in text format is not supported and will cause an error.
///
/// ### `locale_frac_digits`
/// This parameter corresponds to the number of digits after the decimal separator.
///
/// This value must match what Postgres is expecting for the locale set in the database
/// or else the decimal value you see on the client side will not match the `money` value
/// on the server side.
///
/// **For _most_ locales, this value is `2`.**
///
/// If you're not sure what locale your database is set to or how many decimal digits it specifies,
/// you can execute `SHOW lc_monetary;` to get the locale name, and then look it up in this list
/// (you can ignore the `.utf8` prefix):
/// <https://lh.2xlibre.net/values/frac_digits/>
///
/// If that link is dead and you're on a POSIX-compliant system (Unix, FreeBSD) you can also execute:
///
/// ```sh
/// $ LC_MONETARY=<value returned by `SHOW lc_monetary`> locale -k frac_digits
/// ```
///
/// And the value you want is `N` in `frac_digits=N`. If you have shell access to the database
/// server you should execute it there as available locales may differ between machines.
///
/// Note that if `frac_digits` for the locale is outside the range `[0, 10]`, Postgres assumes
/// it's a sentinel value and defaults to 2:
/// <https://github.com/postgres/postgres/blob/master/src/backend/utils/adt/cash.c#L114-L123>
///
/// [`MONEY`]: https://www.postgresql.org/docs/current/datatype-money.html
#[derive(Debug, PartialEq, Eq, Clone, Copy, Default)]
pub struct PgMoney(
/// The raw integer value sent over the wire; for locales with `frac_digits=2` (i.e. most
/// of them), this will be the value in whole cents.
///
/// E.g. for `select '$123.45'::money` with a locale of `en_US` (`frac_digits=2`),
/// this will be `12345`.
///
/// If the currency of your locale does not have fractional units, e.g. Yen, then this will
/// just be the units of the currency.
///
/// See the type-level docs for an explanation of `locale_frac_units`.
pub i64,
);
impl PgMoney {
/// Convert the money value into a [`BigDecimal`] using `locale_frac_digits`.
///
/// See the type-level docs for an explanation of `locale_frac_digits`.
///
/// [`BigDecimal`]: bigdecimal::BigDecimal
#[cfg(feature = "bigdecimal")]
pub fn to_bigdecimal(self, locale_frac_digits: i64) -> bigdecimal::BigDecimal {
let digits = num_bigint::BigInt::from(self.0);
bigdecimal::BigDecimal::new(digits, locale_frac_digits)
}
/// Convert the money value into a [`Decimal`] using `locale_frac_digits`.
///
/// See the type-level docs for an explanation of `locale_frac_digits`.
///
/// [`Decimal`]: rust_decimal::Decimal
#[cfg(feature = "rust_decimal")]
pub fn to_decimal(self, locale_frac_digits: u32) -> rust_decimal::Decimal {
rust_decimal::Decimal::new(self.0, locale_frac_digits)
}
/// Convert a [`Decimal`] value into money using `locale_frac_digits`.
///
/// See the type-level docs for an explanation of `locale_frac_digits`.
///
/// Note that `Decimal` has 96 bits of precision, but `PgMoney` only has 63 plus the sign bit.
/// If the value is larger than 63 bits it will be truncated.
///
/// [`Decimal`]: rust_decimal::Decimal
#[cfg(feature = "rust_decimal")]
pub fn from_decimal(mut decimal: rust_decimal::Decimal, locale_frac_digits: u32) -> Self {
// this is all we need to convert to our expected locale's `frac_digits`
decimal.rescale(locale_frac_digits);
/// a mask to bitwise-AND with an `i64` to zero the sign bit
const SIGN_MASK: i64 = i64::MAX;
let is_negative = decimal.is_sign_negative();
let serialized = decimal.serialize();
// interpret bytes `4..12` as an i64, ignoring the sign bit
// this is where truncation occurs
let value = i64::from_le_bytes(
*<&[u8; 8]>::try_from(&serialized[4..12])
.expect("BUG: slice of serialized should be 8 bytes"),
) & SIGN_MASK; // zero out the sign bit
// negate if necessary
Self(if is_negative { -value } else { value })
}
/// Convert a [`BigDecimal`](bigdecimal::BigDecimal) value into money using the correct precision
/// defined in the PostgreSQL settings. The default precision is two.
#[cfg(feature = "bigdecimal")]
pub fn from_bigdecimal(
decimal: bigdecimal::BigDecimal,
locale_frac_digits: u32,
) -> Result<Self, BoxDynError> {
use bigdecimal::ToPrimitive;
let multiplier = bigdecimal::BigDecimal::new(
num_bigint::BigInt::from(10i128.pow(locale_frac_digits)),
0,
);
let cents = decimal * multiplier;
let money = cents.to_i64().ok_or_else(|| {
io::Error::new(
io::ErrorKind::InvalidData,
"Provided BigDecimal could not convert to i64: overflow.",
)
})?;
Ok(Self(money))
}
}
impl Type<Postgres> for PgMoney {
fn type_info() -> PgTypeInfo {
PgTypeInfo::MONEY
}
}
impl PgHasArrayType for PgMoney {
fn array_type_info() -> PgTypeInfo {
PgTypeInfo::MONEY_ARRAY
}
}
impl<T> From<T> for PgMoney
where
T: Into<i64>,
{
fn from(num: T) -> Self {
Self(num.into())
}
}
impl Encode<'_, Postgres> for PgMoney {
fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> Result<IsNull, BoxDynError> {
buf.extend(&self.0.to_be_bytes());
Ok(IsNull::No)
}
}
impl Decode<'_, Postgres> for PgMoney {
fn decode(value: PgValueRef<'_>) -> Result<Self, BoxDynError> {
match value.format() {
PgValueFormat::Binary => {
let cents = BigEndian::read_i64(value.as_bytes()?);
Ok(PgMoney(cents))
}
PgValueFormat::Text => {
let error = io::Error::new(
io::ErrorKind::InvalidData,
"Reading a `MONEY` value in text format is not supported.",
);
Err(Box::new(error))
}
}
}
}
impl Add<PgMoney> for PgMoney {
type Output = PgMoney;
/// Adds two monetary values.
///
/// # Panics
/// Panics if overflowing the `i64::MAX`.
fn add(self, rhs: PgMoney) -> Self::Output {
self.0
.checked_add(rhs.0)
.map(PgMoney)
.expect("overflow adding money amounts")
}
}
impl AddAssign<PgMoney> for PgMoney {
/// An assigning add for two monetary values.
///
/// # Panics
/// Panics if overflowing the `i64::MAX`.
fn add_assign(&mut self, rhs: PgMoney) {
self.0 = self
.0
.checked_add(rhs.0)
.expect("overflow adding money amounts")
}
}
impl Sub<PgMoney> for PgMoney {
type Output = PgMoney;
/// Subtracts two monetary values.
///
/// # Panics
/// Panics if underflowing the `i64::MIN`.
fn sub(self, rhs: PgMoney) -> Self::Output {
self.0
.checked_sub(rhs.0)
.map(PgMoney)
.expect("overflow subtracting money amounts")
}
}
impl SubAssign<PgMoney> for PgMoney {
/// An assigning subtract for two monetary values.
///
/// # Panics
/// Panics if underflowing the `i64::MIN`.
fn sub_assign(&mut self, rhs: PgMoney) {
self.0 = self
.0
.checked_sub(rhs.0)
.expect("overflow subtracting money amounts")
}
}
#[cfg(test)]
mod tests {
use super::PgMoney;
#[test]
fn adding_works() {
assert_eq!(PgMoney(3), PgMoney(1) + PgMoney(2))
}
#[test]
fn add_assign_works() {
let mut money = PgMoney(1);
money += PgMoney(2);
assert_eq!(PgMoney(3), money);
}
#[test]
fn subtracting_works() {
assert_eq!(PgMoney(4), PgMoney(5) - PgMoney(1))
}
#[test]
fn sub_assign_works() {
let mut money = PgMoney(1);
money -= PgMoney(2);
assert_eq!(PgMoney(-1), money);
}
#[test]
fn default_value() {
let money = PgMoney::default();
assert_eq!(money, PgMoney(0));
}
#[test]
#[should_panic]
fn add_overflow_panics() {
let _ = PgMoney(i64::MAX) + PgMoney(1);
}
#[test]
#[should_panic]
fn add_assign_overflow_panics() {
let mut money = PgMoney(i64::MAX);
money += PgMoney(1);
}
#[test]
#[should_panic]
fn sub_overflow_panics() {
let _ = PgMoney(i64::MIN) - PgMoney(1);
}
#[test]
#[should_panic]
fn sub_assign_overflow_panics() {
let mut money = PgMoney(i64::MIN);
money -= PgMoney(1);
}
#[test]
#[cfg(feature = "bigdecimal")]
fn conversion_to_bigdecimal_works() {
let money = PgMoney(12345);
assert_eq!(
bigdecimal::BigDecimal::new(num_bigint::BigInt::from(12345), 2),
money.to_bigdecimal(2)
);
}
#[test]
#[cfg(feature = "rust_decimal")]
fn conversion_to_decimal_works() {
assert_eq!(
rust_decimal::Decimal::new(12345, 2),
PgMoney(12345).to_decimal(2)
);
}
#[test]
#[cfg(feature = "rust_decimal")]
fn conversion_from_decimal_works() {
assert_eq!(
PgMoney(12345),
PgMoney::from_decimal(rust_decimal::Decimal::new(12345, 2), 2)
);
assert_eq!(
PgMoney(12345),
PgMoney::from_decimal(rust_decimal::Decimal::new(123450, 3), 2)
);
assert_eq!(
PgMoney(-12345),
PgMoney::from_decimal(rust_decimal::Decimal::new(-123450, 3), 2)
);
assert_eq!(
PgMoney(-12300),
PgMoney::from_decimal(rust_decimal::Decimal::new(-123, 0), 2)
);
}
#[test]
#[cfg(feature = "bigdecimal")]
fn conversion_from_bigdecimal_works() {
let dec = bigdecimal::BigDecimal::new(num_bigint::BigInt::from(12345), 2);
assert_eq!(PgMoney(12345), PgMoney::from_bigdecimal(dec, 2).unwrap());
}
}