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
use core::fmt::{self, LowerExp, UpperExp};
use aws_sdk_dynamodb::types::AttributeValue;
/// A DynamoDB [numeric][1] value.
///
/// See also: [`Scalar::new_num`], [`Value::new_num`],
/// [`Scalar::new_num_lower_exp`], [`Value::new_num_lower_exp`],
/// [`Scalar::new_num_upper_exp`], [`Value::new_num_upper_exp`]
///
/// # Examples
///
/// ```
/// use dynamodb_expression::value::Num;
/// # use pretty_assertions::assert_eq;
///
/// let value = Num::new(2600);
/// assert_eq!("2600", value.to_string());
///
/// let value = Num::new_lower_exp(2600);
/// assert_eq!("2.6e3", value.to_string());
///
/// let value = Num::new_upper_exp(2600);
/// assert_eq!("2.6E3", value.to_string());
///
/// let value = Num::new(2600.0);
/// assert_eq!("2600", value.to_string());
///
/// let value = Num::new_lower_exp(2600.0);
/// assert_eq!("2.6e3", value.to_string());
///
/// let value = Num::new_upper_exp(2600.0);
/// assert_eq!("2.6E3", value.to_string());
/// ```
///
/// [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes.Number
/// [`Scalar::new_num`]: crate::value::Scalar::new_num
/// [`Scalar::new_num_lower_exp`]: crate::value::Scalar::new_num_lower_exp
/// [`Scalar::new_num_upper_exp`]: crate::value::Scalar::new_num_upper_exp
/// [`Value::new_num`]: crate::value::Value::new_num
/// [`Value::new_num_lower_exp`]: crate::value::Value::new_num_lower_exp
/// [`Value::new_num_upper_exp`]: crate::value::Value::new_num_upper_exp
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Num {
pub(crate) n: String,
}
impl Num {
/// Creates a DynamoDB [numeric][1] value.
///
/// See also: [`Num::new_lower_exp`], [`Num::new_upper_exp`], [`Scalar::new_num`],
/// [`Value::new_num`]
///
/// # Examples
///
/// ```
/// use dynamodb_expression::value::Num;
/// # use pretty_assertions::assert_eq;
///
/// let value = Num::new(2600);
/// assert_eq!("2600", value.to_string());
///
/// let value = Num::new(2600.0);
/// assert_eq!("2600", value.to_string());
/// ```
///
/// [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes.Number
/// [`Scalar::new_num`]: crate::value::Scalar::new_num
/// [`Value::new_num`]: crate::value::Value::new_num
pub fn new<T>(value: T) -> Self
where
T: ToString + num::Num,
{
Self {
n: value.to_string(),
}
}
/// Creates a DynamoDB [numeric][1] value.
///
/// See also: [`Num::new`], [`Num::new_upper_exp`], [`Scalar::new_num_lower_exp`],
/// [`Value::new_num_lower_exp`]
///
/// # Examples
///
/// ```
/// use dynamodb_expression::value::Num;
/// # use pretty_assertions::assert_eq;
///
/// let value = Num::new_lower_exp(2600);
/// assert_eq!("2.6e3", value.to_string());
///
/// let value = Num::new_lower_exp(2600.0);
/// assert_eq!("2.6e3", value.to_string());
/// ```
///
/// [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes.Number
/// [`Scalar::new_num_lower_exp`]: crate::value::Scalar::new_num_lower_exp
/// [`Value::new_num_lower_exp`]: crate::value::Value::new_num_lower_exp
pub fn new_lower_exp<T>(value: T) -> Self
where
T: LowerExp + num::Num,
{
Self {
n: format!("{value:e}"),
}
}
/// Creates a DynamoDB [numeric][1] value.
///
/// See also: [`Num::new`], [`Num::new_lower_exp`], [`Scalar::new_num_upper_exp`],
/// [`Value::new_num_upper_exp`]
///
/// # Examples
///
/// ```
/// use dynamodb_expression::value::Num;
/// # use pretty_assertions::assert_eq;
///
/// let value = Num::new_upper_exp(2600);
/// assert_eq!("2.6E3", value.to_string());
///
/// let value = Num::new_upper_exp(2600.0);
/// assert_eq!("2.6E3", value.to_string());
/// ```
///
/// [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes.Number
/// [`Scalar::new_num_upper_exp`]: crate::value::Scalar::new_num_upper_exp
/// [`Value::new_num_upper_exp`]: crate::value::Value::new_num_upper_exp
pub fn new_upper_exp<T>(value: T) -> Self
where
T: UpperExp + num::Num,
{
Self {
n: format!("{value:E}"),
}
}
// Intentionally not using `impl From<Num> for AttributeValue` because
// I don't want to make this a public API people rely on. The purpose of this
// crate is not to make creating `AttributeValues` easier. They should try
// `serde_dynamo`.
pub(super) fn into_attribute_value(self) -> AttributeValue {
AttributeValue::N(self.n)
}
}
impl fmt::Display for Num {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.n.fmt(f)
}
}
impl<T> From<T> for Num
where
T: ToString + num::Num,
{
fn from(num: T) -> Self {
Num::new(num)
}
}
impl From<Num> for String {
fn from(num: Num) -> Self {
num.n
}
}