#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum BigNumberError {
InvalidFormat(String),
ExponentOutOfRange(String),
}
impl std::fmt::Display for BigNumberError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
BigNumberError::InvalidFormat(s) => write!(f, "invalid number format: {s}"),
BigNumberError::ExponentOutOfRange(s) => {
write!(f, "number exponent is outside the supported range: {s}")
}
}
}
}
impl std::error::Error for BigNumberError {}
fn is_ascii_digits(s: &str) -> bool {
!s.is_empty() && s.bytes().all(|b| b.is_ascii_digit())
}
fn is_valid_big_integer(s: &str) -> bool {
is_ascii_digits(s.strip_prefix('-').unwrap_or(s))
}
fn validate_big_decimal(s: &str) -> Result<(), BigNumberError> {
let invalid_format = || BigNumberError::InvalidFormat(s.to_string());
let exponent_out_of_range = || BigNumberError::ExponentOutOfRange(s.to_string());
let (coefficient, exponent) = match s.split_once(['e', 'E']) {
Some((coefficient, exponent)) => match exponent.parse::<i128>() {
Ok(exponent) => (coefficient, exponent),
Err(error)
if matches!(
error.kind(),
std::num::IntErrorKind::PosOverflow | std::num::IntErrorKind::NegOverflow
) =>
{
return Err(exponent_out_of_range());
}
Err(_) => return Err(invalid_format()),
},
None => (s, 0),
};
let coefficient = coefficient.strip_prefix(['-', '+']).unwrap_or(coefficient);
let (integer, fraction) = coefficient.split_once('.').unwrap_or((coefficient, ""));
if (integer.is_empty() && fraction.is_empty())
|| !integer
.bytes()
.chain(fraction.bytes())
.all(|byte| byte.is_ascii_digit())
{
return Err(invalid_format());
}
match (fraction.len() as i128).checked_sub(exponent) {
Some(scale) if (-(i64::MAX as i128)..=i64::MAX as i128).contains(&scale) => Ok(()),
_ => Err(exponent_out_of_range()),
}
}
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(
all(aws_sdk_unstable, feature = "serde-serialize"),
derive(serde::Serialize)
)]
pub struct BigInteger(String);
#[cfg(all(aws_sdk_unstable, feature = "serde-deserialize"))]
impl<'de> serde::Deserialize<'de> for BigInteger {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
let value = <String as serde::Deserialize>::deserialize(deserializer)?;
value.parse().map_err(serde::de::Error::custom)
}
}
impl Default for BigInteger {
fn default() -> Self {
Self("0".to_string())
}
}
impl std::str::FromStr for BigInteger {
type Err = BigNumberError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
if !is_valid_big_integer(s) {
return Err(BigNumberError::InvalidFormat(s.to_string()));
}
Ok(Self(s.to_string()))
}
}
impl AsRef<str> for BigInteger {
fn as_ref(&self) -> &str {
&self.0
}
}
#[derive(Debug, Clone)]
#[cfg_attr(
all(aws_sdk_unstable, feature = "serde-serialize"),
derive(serde::Serialize)
)]
pub struct BigDecimal(String);
struct Canonical<'a> {
negative: bool,
integer: &'a str,
fraction: &'a str,
exponent: i128,
}
impl<'a> Canonical<'a> {
fn of(s: &'a str) -> Self {
let (coefficient, exponent) = match s.split_once(['e', 'E']) {
Some((coefficient, exponent)) => (
coefficient,
exponent.parse::<i128>().expect("validated when parsed"),
),
None => (s, 0),
};
let negative = coefficient.starts_with('-');
let coefficient = coefficient.strip_prefix(['-', '+']).unwrap_or(coefficient);
let (integer, fraction) = coefficient.split_once('.').unwrap_or((coefficient, ""));
let mut exponent = exponent - fraction.len() as i128;
let mut fraction_kept = fraction.trim_end_matches('0');
exponent += (fraction.len() - fraction_kept.len()) as i128;
let mut integer_kept = integer;
if fraction_kept.is_empty() {
integer_kept = integer.trim_end_matches('0');
exponent += (integer.len() - integer_kept.len()) as i128;
}
integer_kept = integer_kept.trim_start_matches('0');
if integer_kept.is_empty() {
fraction_kept = fraction_kept.trim_start_matches('0');
}
if integer_kept.is_empty() && fraction_kept.is_empty() {
return Self {
negative: false,
integer: "",
fraction: "",
exponent: 0,
};
}
Self {
negative,
integer: integer_kept,
fraction: fraction_kept,
exponent,
}
}
fn digits(&self) -> impl Iterator<Item = u8> + 'a {
self.integer.bytes().chain(self.fraction.bytes())
}
}
impl PartialEq for BigDecimal {
fn eq(&self, other: &Self) -> bool {
let (a, b) = (Canonical::of(&self.0), Canonical::of(&other.0));
a.negative == b.negative && a.exponent == b.exponent && a.digits().eq(b.digits())
}
}
impl Eq for BigDecimal {}
impl std::hash::Hash for BigDecimal {
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
let canonical = Canonical::of(&self.0);
canonical.negative.hash(state);
canonical.exponent.hash(state);
let mut count = 0usize;
for digit in canonical.digits() {
state.write_u8(digit);
count += 1;
}
state.write_usize(count);
}
}
#[cfg(all(aws_sdk_unstable, feature = "serde-deserialize"))]
impl<'de> serde::Deserialize<'de> for BigDecimal {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
let value = <String as serde::Deserialize>::deserialize(deserializer)?;
value.parse().map_err(serde::de::Error::custom)
}
}
impl Default for BigDecimal {
fn default() -> Self {
Self("0.0".to_string())
}
}
impl std::str::FromStr for BigDecimal {
type Err = BigNumberError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
validate_big_decimal(s)?;
Ok(Self(s.to_string()))
}
}
impl AsRef<str> for BigDecimal {
fn as_ref(&self) -> &str {
&self.0
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::str::FromStr;
#[test]
fn big_integer_basic() {
let bi = BigInteger::from_str("12345678901234567890").unwrap();
assert_eq!(bi.as_ref(), "12345678901234567890");
}
#[test]
fn big_integer_default() {
let bi = BigInteger::default();
assert_eq!(bi.as_ref(), "0");
assert_eq!(BigInteger::from_str(bi.as_ref()).unwrap(), bi);
}
#[test]
fn big_decimal_basic() {
let bd = BigDecimal::from_str("123.456789").unwrap();
assert_eq!(bd.as_ref(), "123.456789");
}
#[test]
fn big_decimal_default() {
let bd = BigDecimal::default();
assert_eq!(bd.as_ref(), "0.0");
assert_eq!(BigDecimal::from_str(bd.as_ref()).unwrap(), bd);
}
#[test]
fn big_integer_negative() {
let bi = BigInteger::from_str("-12345").unwrap();
assert_eq!(bi.as_ref(), "-12345");
}
#[test]
fn big_decimal_scientific() {
let bd = BigDecimal::from_str("1.23e10").unwrap();
assert_eq!(bd.as_ref(), "1.23e10");
let bd = BigDecimal::from_str("1.23E-10").unwrap();
assert_eq!(bd.as_ref(), "1.23E-10");
}
#[test]
fn big_decimal_accepts_supported_formats() {
for value in ["0", "+5", "-0.0", ".5", "-.5", "5.", "1.5E+3"] {
assert!(BigDecimal::from_str(value).is_ok(), "{value}");
}
}
#[test]
fn big_decimal_rejects_malformed_values() {
for value in [
"1.2.3", "-", "+", ".", "e", "E", "1e", "1e+", "--5", "1-2", "12-34", "..", "1.2e3.4",
"+-1",
] {
assert_eq!(
BigDecimal::from_str(value),
Err(BigNumberError::InvalidFormat(value.to_string())),
"{value}"
);
}
}
#[test]
fn big_decimal_rejects_out_of_range_exponents() {
for value in [
"1E99999999999999999999",
"1E-99999999999999999999",
"1e9223372036854775808",
"1e-9223372036854775808",
"1e999999999999999999999999999999999999999",
] {
assert_eq!(
BigDecimal::from_str(value),
Err(BigNumberError::ExponentOutOfRange(value.to_string())),
"{value}"
);
}
}
fn hash_of(value: &BigDecimal) -> u64 {
use std::hash::{BuildHasher, BuildHasherDefault};
BuildHasherDefault::<std::collections::hash_map::DefaultHasher>::default().hash_one(value)
}
fn assert_same_value(a: &str, b: &str) {
let (x, y) = (
BigDecimal::from_str(a).unwrap(),
BigDecimal::from_str(b).unwrap(),
);
assert_eq!(x, y, "{a} should equal {b}");
assert_eq!(hash_of(&x), hash_of(&y), "{a} and {b} should hash the same");
}
#[test]
fn big_decimal_compares_numeric_values_not_spellings() {
for (a, b) in [
("1e2", "100"),
("1.0", "1.00"),
("+5", "5"),
("-0.0", "0"),
(".5", "0.5"),
("5.", "5"),
("1.5E+3", "1500"),
("150e1", "1.5e3"),
("0.0012", "1.2e-3"),
("12e-5", "0.00012"),
("00123.4500", "123.45"),
("-007e2", "-700"),
("1E0", "1"),
("10.0", "1e1"),
("0", "-0"),
("0.000", "0e50"),
("-.0e-9", "+0"),
("0.0", "0"),
] {
assert_same_value(a, b);
}
}
#[test]
fn big_decimal_keeps_different_values_different() {
for (a, b) in [
("1", "-1"),
("1", "10"),
("1.5", "15"),
("0.1", "0.01"),
("1e2", "1e3"),
("12", "21"),
("1.2", "1.02"),
("100", "101"),
("0", "1e-999"),
("-0.5", "0.5"),
] {
assert_ne!(
BigDecimal::from_str(a).unwrap(),
BigDecimal::from_str(b).unwrap(),
"{a} should not equal {b}"
);
}
}
#[test]
fn big_decimal_equality_keeps_the_original_spelling() {
let scientific = BigDecimal::from_str("1e2").unwrap();
let plain = BigDecimal::from_str("100").unwrap();
assert_eq!(scientific, plain);
assert_eq!(scientific.as_ref(), "1e2");
assert_eq!(plain.as_ref(), "100");
}
#[test]
fn big_decimal_works_as_a_hash_set_key() {
let values: std::collections::HashSet<BigDecimal> = ["100", "1e2", "100.000", "+1E+2", "7"]
.into_iter()
.map(|v| BigDecimal::from_str(v).unwrap())
.collect();
assert_eq!(values.len(), 2);
assert!(values.contains(&BigDecimal::from_str("10e1").unwrap()));
}
#[test]
fn big_decimal_default_equals_zero() {
assert_eq!(BigDecimal::default(), BigDecimal::from_str("0").unwrap());
}
#[test]
fn big_decimal_compares_exponents_at_the_supported_extremes() {
assert_same_value("1e9223372036854775807", "10e9223372036854775806");
assert_same_value("1e-9223372036854775806", "0.1e-9223372036854775805");
assert_ne!(
BigDecimal::from_str("1e9223372036854775807").unwrap(),
BigDecimal::from_str("1e9223372036854775806").unwrap()
);
}
mod numeric_equality {
use super::super::BigDecimal;
use proptest::prelude::*;
use std::str::FromStr;
fn spell(
negative: bool,
digits: &str,
exponent: i64,
shift: usize,
lead: usize,
trail: usize,
) -> String {
let sign = if negative { "-" } else { "" };
let mut all = format!("{}{digits}{}", "0".repeat(lead), "0".repeat(trail));
if shift > all.len() {
all = format!("{}{all}", "0".repeat(shift - all.len()));
}
let point = all.len() - shift;
let exponent = exponent - trail as i64 + shift as i64;
format!("{sign}{}.{}e{exponent}", &all[..point], &all[point..])
}
proptest! {
#[test]
fn every_spelling_of_a_value_is_equal(
negative in any::<bool>(),
digits in "[1-9]([0-9]{0,20}[1-9])?",
exponent in -1000i64..1000,
shift_a in 0usize..30, lead_a in 0usize..5, trail_a in 0usize..5,
shift_b in 0usize..30, lead_b in 0usize..5, trail_b in 0usize..5,
) {
let a = spell(negative, &digits, exponent, shift_a, lead_a, trail_a);
let b = spell(negative, &digits, exponent, shift_b, lead_b, trail_b);
let (x, y) = (BigDecimal::from_str(&a).unwrap(), BigDecimal::from_str(&b).unwrap());
prop_assert_eq!(&x, &y, "{} vs {}", a, b);
prop_assert_eq!(super::hash_of(&x), super::hash_of(&y));
}
#[test]
fn different_values_are_not_equal(
negative in any::<bool>(),
digits in "[1-9]([0-9]{0,20}[1-9])?",
exponent in -1000i64..1000,
bump in 1i64..5,
shift in 0usize..30,
) {
let a = spell(negative, &digits, exponent, shift, 0, 0);
let b = spell(negative, &digits, exponent + bump, shift, 0, 0);
let c = spell(!negative, &digits, exponent, shift, 0, 0);
let x = BigDecimal::from_str(&a).unwrap();
prop_assert_ne!(&x, &BigDecimal::from_str(&b).unwrap(), "{} vs {}", a, b);
prop_assert_ne!(&x, &BigDecimal::from_str(&c).unwrap(), "{} vs {}", a, c);
}
}
}
#[test]
fn big_integer_rejects_json_injection() {
assert!(BigInteger::from_str("123, \"injected\": true").is_err());
assert!(BigInteger::from_str("123}").is_err());
assert!(BigInteger::from_str("{\"hacked\": 1}").is_err());
assert!(BigInteger::from_str("123\"").is_err());
assert!(BigInteger::from_str("123\\n456").is_err());
}
#[test]
fn big_decimal_rejects_json_injection() {
assert!(BigDecimal::from_str("123.45, \"injected\": true").is_err());
assert!(BigDecimal::from_str("123.45}").is_err());
assert!(BigDecimal::from_str("{\"hacked\": 1.0}").is_err());
}
#[test]
fn big_integer_rejects_invalid_chars() {
assert!(BigInteger::from_str("abc").is_err());
assert!(BigInteger::from_str("123abc").is_err());
assert!(BigInteger::from_str("12 34").is_err());
assert!(BigInteger::from_str("").is_err());
}
#[test]
fn big_integer_rejects_decimal_and_scientific() {
assert!(BigInteger::from_str("123.45").is_err());
assert!(BigInteger::from_str("123.0").is_err());
assert!(BigInteger::from_str("1e10").is_err());
assert!(BigInteger::from_str("1E10").is_err());
assert!(BigInteger::from_str("1.23e10").is_err());
}
#[test]
fn big_decimal_rejects_invalid_chars() {
assert!(BigDecimal::from_str("abc").is_err());
assert!(BigDecimal::from_str("123.45abc").is_err());
assert!(BigDecimal::from_str("12.34 56").is_err());
assert!(BigDecimal::from_str("").is_err());
}
#[test]
fn big_integer_rejects_a_leading_plus() {
assert!(BigInteger::from_str("+123").is_err());
assert!(BigInteger::from_str("+0").is_err());
}
#[test]
fn big_numbers_reject_bare_and_repeated_signs() {
for bad in ["-", "+", "--5", "++5", "-+5", "+-5", "5-", "5+"] {
assert!(
BigInteger::from_str(bad).is_err(),
"BigInteger::from_str({bad:?}) should fail"
);
assert!(
BigDecimal::from_str(bad).is_err(),
"BigDecimal::from_str({bad:?}) should fail"
);
}
}
#[test]
fn big_decimal_rejects_malformed_separators_and_exponents() {
for bad in [
"1..2", "1.2.3", "0.0.0", "1e", "1E", "1e+", "1e-", "e10", "-e10", "1e2e3", "1.5e", "1e2.5", "1e 2", "1 .5", ".", "1.2e3e", ] {
assert!(
BigDecimal::from_str(bad).is_err(),
"BigDecimal::from_str({bad:?}) should fail"
);
}
}
#[test]
fn big_decimal_accepts_additional_supported_formats() {
for good in [
"0",
"-0",
"123",
"-123",
"1.5",
"-0.5",
"1e3",
"1E3",
"1e+9",
"1e-9",
"1.23e10",
"1.23E-10",
"10.0",
"5e-3",
"0.123456789012345678901234567890",
"12345678901234567890.123",
"1.234e500",
] {
let bd = BigDecimal::from_str(good)
.unwrap_or_else(|e| panic!("BigDecimal::from_str({good:?}) should succeed: {e}"));
assert_eq!(bd.as_ref(), good);
}
}
#[test]
fn big_numbers_still_accept_leading_zeros() {
for good in ["00123", "007", "-01", "0000", "-0000"] {
let bi = BigInteger::from_str(good)
.unwrap_or_else(|e| panic!("BigInteger::from_str({good:?}) should succeed: {e}"));
assert_eq!(bi.as_ref(), good);
let bd = BigDecimal::from_str(good)
.unwrap_or_else(|e| panic!("BigDecimal::from_str({good:?}) should succeed: {e}"));
assert_eq!(bd.as_ref(), good);
}
for good in ["00.1", "-01.5", "007e2"] {
let bd = BigDecimal::from_str(good)
.unwrap_or_else(|e| panic!("BigDecimal::from_str({good:?}) should succeed: {e}"));
assert_eq!(bd.as_ref(), good);
}
}
#[test]
fn big_integer_accepts_only_digits_after_an_optional_minus() {
for good in ["0", "-0", "1", "-1", "12345678901234567890"] {
assert!(
BigInteger::from_str(good).is_ok(),
"BigInteger::from_str({good:?}) should succeed"
);
}
for bad in ["1_000", "1,000", "0x1f", " 1", "1 ", "\t1", "1\n"] {
assert!(
BigInteger::from_str(bad).is_err(),
"BigInteger::from_str({bad:?}) should fail"
);
}
}
#[test]
fn big_number_error_reports_the_offending_input() {
let err = BigInteger::from_str("+123").unwrap_err();
assert_eq!(err, BigNumberError::InvalidFormat("+123".to_string()));
assert!(err.to_string().contains("+123"));
}
#[cfg(all(aws_sdk_unstable, feature = "serde-deserialize"))]
#[test]
fn serde_deserialization_preserves_big_number_invariants() {
let integer: BigInteger = serde_json::from_str(r#""00123""#).unwrap();
assert_eq!(integer.as_ref(), "00123");
assert!(serde_json::from_str::<BigInteger>(r#""+123""#).is_err());
for value in ["+5", ".5", "-.5", "5.", "1.5E+3"] {
let json = format!(r#""{value}""#);
let decimal: BigDecimal = serde_json::from_str(&json).unwrap();
assert_eq!(decimal.as_ref(), value);
}
for value in ["1.2.3", "--5", "1e"] {
let json = format!(r#""{value}""#);
assert!(serde_json::from_str::<BigDecimal>(&json).is_err());
}
let error = serde_json::from_str::<BigDecimal>(r#""1E99999999999999999999""#).unwrap_err();
assert!(error.to_string().contains("outside the supported range"));
}
}