Struct elephantry::Money

pub struct Money(/* private fields */);

Available on crate feature money only.

Rust type for money. Representation of the Postgres ‘money’ type

Implementations

impl Money

pub fn parse_str(input: &str) -> Result<Money, Error>

Attempt to parse a &str into a Money.

NOTE: as of this writing, only the Postgres en_US.UTF-8 locale is supported.

For more information about the Postgres money type, please see 8.2. Monetary Types.

For more about how locales work with monetary values, please see lc_monetary.

Examples

Parse a string of dollars

use postgres_money::Money;
let dollars = "324023040222";
let money = Money::parse_str(dollars).unwrap();

assert_eq!("$324023040222.00", money.to_string());

Parse a string of cents

use postgres_money::Money;
let dollars = ".32";
let money = Money::parse_str(dollars).unwrap();

assert_eq!("$0.32", money.to_string());

Parse a string with dollars and cents

use postgres_money::Money;
let dollars = "93.32";
let money = Money::parse_str(dollars).unwrap();

assert_eq!("$93.32", money.to_string());

Handles parentheses

use postgres_money::Money;
let dollars = "(93.32)";
let money = Money::parse_str(dollars).unwrap();

assert_eq!("-$93.32", money.to_string());

Handles dollar symbols

use postgres_money::Money;
let dollars = "$93.32";
let money = Money::parse_str(dollars).unwrap();

assert_eq!("$93.32", money.to_string());

Rounds correctly

use postgres_money::Money;
let dollars = "$123.454";
let money = Money::parse_str(dollars).unwrap();

assert_eq!("$123.45", money.to_string());

let dollars = "$123.455";
let money = Money::parse_str(dollars).unwrap();

assert_eq!("$123.46", money.to_string());

Handles commas

use postgres_money::Money;
let dollars = "$123,456.78";
let money = Money::parse_str(dollars).unwrap();

assert_eq!("$123456.78", money.to_string());

Max value

use postgres_money::Money;
let dollars = "92233720368547758.07";
let money = Money::parse_str(dollars).unwrap();

assert_eq!("$92233720368547758.07", money.to_string());
assert_eq!(Money::max().to_string(), money.to_string());

Min value

use postgres_money::Money;
let dollars = "-92233720368547758.08";
let money = Money::parse_str(dollars).unwrap();

assert_eq!("-$92233720368547758.08", money.to_string());
assert_eq!(Money::min().to_string(), money.to_string());

pub fn from(cents: i64) -> Money

Construct a Money instance from an i64

Examples

use postgres_money::Money;
let cents = 324023040222;
let money = Money::from(cents);

assert_eq!("$3240230402.22", money.to_string());

impl Money

pub const fn min() -> Money

Minimum allowable value for Money

pub const fn max() -> Money

Maximum allowable value for Money

pub const fn none() -> Money

Instantiate Money as zero

pub const fn inner(&self) -> i64

Expose the wrapped i64 value

Trait Implementations

impl Add for Money

type Output = Money

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Money

fn clone(&self) -> Money

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Money

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

Formats the value using the given formatter.

impl Default for Money

fn default() -> Money

Returns the “default value” for a type.

impl Display for Money

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

Formats the value using the given formatter.

impl Div<f32> for Money

type Output = Money

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> <Money as Div<f32>>::Output

Performs the / operation.

impl Div<f64> for Money

type Output = Money

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> <Money as Div<f64>>::Output

Performs the / operation.

impl Div<i16> for Money

type Output = Money

The resulting type after applying the / operator.

fn div(self, rhs: i16) -> <Money as Div<i16>>::Output

Performs the / operation.

impl Div<i32> for Money

type Output = Money

The resulting type after applying the / operator.

fn div(self, rhs: i32) -> <Money as Div<i32>>::Output

Performs the / operation.

impl Div<i64> for Money

type Output = Money

The resulting type after applying the / operator.

fn div(self, rhs: i64) -> <Money as Div<i64>>::Output

Performs the / operation.

impl Div<i8> for Money

type Output = Money

The resulting type after applying the / operator.

fn div(self, rhs: i8) -> <Money as Div<i8>>::Output

Performs the / operation.

impl Div<u16> for Money

type Output = Money

The resulting type after applying the / operator.

fn div(self, rhs: u16) -> <Money as Div<u16>>::Output

Performs the / operation.

impl Div<u32> for Money

type Output = Money

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> <Money as Div<u32>>::Output

Performs the / operation.

impl Div<u8> for Money

type Output = Money

The resulting type after applying the / operator.

fn div(self, rhs: u8) -> <Money as Div<u8>>::Output

Performs the / operation.

impl FromSql for Money

fn from_text(ty: &Type, raw: Option<&str>) -> Result<Self>

Create a new struct from the text representation.

fn from_binary(ty: &Type, raw: Option<&[u8]>) -> Result<Self>

Create a new struct from the binary representation.

fn from_sql(ty: &Type, format: Format, raw: Option<&[u8]>) -> Result<Self>

Create a new struct from SQL value.

fn error<T: Debug>(pg_type: &Type, raw: T) -> Error

impl FromStr for Money

type Err = Error

The associated error which can be returned from parsing.

fn from_str(money_str: &str) -> Result<Money, <Money as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Money

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul<f32> for Money

type Output = Money

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> <Money as Mul<f32>>::Output

Performs the * operation.

impl Mul<f64> for Money

type Output = Money

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> <Money as Mul<f64>>::Output

Performs the * operation.

impl Mul<i16> for Money

type Output = Money

The resulting type after applying the * operator.

fn mul(self, rhs: i16) -> <Money as Mul<i16>>::Output

Performs the * operation.

impl Mul<i32> for Money

type Output = Money

The resulting type after applying the * operator.

fn mul(self, rhs: i32) -> <Money as Mul<i32>>::Output

Performs the * operation.

impl Mul<i64> for Money

type Output = Money

The resulting type after applying the * operator.

fn mul(self, rhs: i64) -> <Money as Mul<i64>>::Output

Performs the * operation.

impl Mul<i8> for Money

type Output = Money

The resulting type after applying the * operator.

fn mul(self, rhs: i8) -> <Money as Mul<i8>>::Output

Performs the * operation.

impl Mul<u16> for Money

type Output = Money

The resulting type after applying the * operator.

fn mul(self, rhs: u16) -> <Money as Mul<u16>>::Output

Performs the * operation.

impl Mul<u32> for Money

type Output = Money

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> <Money as Mul<u32>>::Output

Performs the * operation.

impl Mul<u8> for Money

type Output = Money

The resulting type after applying the * operator.

fn mul(self, rhs: u8) -> <Money as Mul<u8>>::Output

Performs the * operation.

impl Ord for Money

fn cmp(&self, other: &Money) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Money

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Money

fn partial_cmp(&self, other: &Money) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for Money

type Output = Money

The resulting type after applying the - operator.

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

Performs the - operation.

impl ToSql for Money

fn ty(&self) -> Type

The corresponding SQL type

fn to_text(&self) -> Result<Option<String>>

Convert the value to text format

fn to_binary(&self) -> Result<Option<Vec<u8>>>

Convert the value to binary format

fn error(&self, message: &str) -> Error

impl Copy for Money

impl Eq for Money

impl Simple for Money

impl StructuralPartialEq for Money