Struct sqlx::postgres::types::PgMoney

pub struct PgMoney(pub i64);

Available on crate feature postgres only.

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:

$ 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

Tuple Fields

0: i64

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.

Implementations

impl PgMoney

pub fn to_bigdecimal(self, locale_frac_digits: i64) -> BigDecimal

Convert the money value into a BigDecimal using locale_frac_digits.

See the type-level docs for an explanation of locale_frac_digits.

pub fn to_decimal(self, locale_frac_digits: u32) -> Decimal

Convert the money value into a Decimal using locale_frac_digits.

See the type-level docs for an explanation of locale_frac_digits.

pub fn from_decimal(decimal: Decimal, locale_frac_digits: u32) -> PgMoney

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.

pub fn from_bigdecimal( decimal: BigDecimal, locale_frac_digits: u32, ) -> Result<PgMoney, Box<dyn Error + Sync + Send>>

Convert a BigDecimal value into money using the correct precision defined in the PostgreSQL settings. The default precision is two.

Trait Implementations

impl Add for PgMoney

fn add(self, rhs: PgMoney) -> <PgMoney as Add>::Output

Adds two monetary values.

Panics

Panics if overflowing the i64::MAX.

type Output = PgMoney

The resulting type after applying the + operator.

impl AddAssign for PgMoney

fn add_assign(&mut self, rhs: PgMoney)

An assigning add for two monetary values.

Panics

Panics if overflowing the i64::MAX.

impl Clone for PgMoney

fn clone(&self) -> PgMoney

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PgMoney

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Decode<'_, Postgres> for PgMoney

fn decode( value: PgValueRef<'_>, ) -> Result<PgMoney, Box<dyn Error + Sync + Send>>

Decode a new value of this type using a raw value from the database.

impl Default for PgMoney

fn default() -> PgMoney

Returns the “default value” for a type.

impl Encode<'_, Postgres> for PgMoney

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

Writes the value of self into buf without moving self.

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where Self: Sized,

Writes the value of self into buf in the expected format for the database.

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

fn size_hint(&self) -> usize

impl<T> From<T> for PgMoney

where T: Into<i64>,

fn from(num: T) -> PgMoney

Converts to this type from the input type.

impl PartialEq for PgMoney

fn eq(&self, other: &PgMoney) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PgHasArrayType for PgMoney

fn array_type_info() -> PgTypeInfo

fn array_compatible(ty: &PgTypeInfo) -> bool

impl Sub for PgMoney

fn sub(self, rhs: PgMoney) -> <PgMoney as Sub>::Output

Subtracts two monetary values.

Panics

Panics if underflowing the i64::MIN.

type Output = PgMoney

The resulting type after applying the - operator.

impl SubAssign for PgMoney

fn sub_assign(&mut self, rhs: PgMoney)

An assigning subtract for two monetary values.

Panics

Panics if underflowing the i64::MIN.

impl Type<Postgres> for PgMoney

fn type_info() -> PgTypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &<DB as Database>::TypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.

impl Copy for PgMoney

impl Eq for PgMoney

impl StructuralPartialEq for PgMoney