Struct Dollars 

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

US Dollar amount as floating point

Implementations

impl Dollars

pub const ZERO: Self

pub const NAN: Self

pub const fn mint(dollars: f64) -> Self

pub fn round_nearest_cent(self) -> Self

pub fn round_to(self, digits: i32) -> Self

pub fn is_negative(&self) -> bool

pub fn is_zero(&self) -> bool

pub fn halved(self) -> Self

pub fn to_cents(self) -> Cents

Methods from Deref<Target = f64>

pub const RADIX: u32 = 2

pub const BITS: u32 = 64

pub const MANTISSA_DIGITS: u32 = 53

pub const DIGITS: u32 = 15

pub const EPSILON: f64 = 2.2204460492503131e-16_f64

pub const MIN: f64 = -1.7976931348623157e+308_f64

pub const MIN_POSITIVE: f64 = 2.2250738585072014e-308_f64

pub const MAX: f64 = 1.7976931348623157e+308_f64

pub const MIN_EXP: i32 = -1021

pub const MAX_EXP: i32 = 1024

pub const MIN_10_EXP: i32 = -307

pub const MAX_10_EXP: i32 = 308

pub const NAN: f64

pub const INFINITY: f64

pub const NEG_INFINITY: f64

pub const MAX_EXACT_INTEGER: i64

pub const MIN_EXACT_INTEGER: i64

pub fn total_cmp(&self, other: &f64) -> Ordering

Returns the ordering between self and other.

Unlike the standard partial comparison between floating point numbers, this comparison always produces an ordering in accordance to the totalOrder predicate as defined in the IEEE 754 (2008 revision) floating point standard. The values are ordered in the following sequence:

• negative quiet NaN
• negative signaling NaN
• negative infinity
• negative numbers
• negative subnormal numbers
• negative zero
• positive zero
• positive subnormal numbers
• positive numbers
• positive infinity
• positive signaling NaN
• positive quiet NaN.

The ordering established by this function does not always agree with the PartialOrd and PartialEq implementations of f64. For example, they consider negative and positive zero equal, while total_cmp doesn’t.

The interpretation of the signaling NaN bit follows the definition in the IEEE 754 standard, which may not match the interpretation by some of the older, non-conformant (e.g. MIPS) hardware implementations.

Example

struct GoodBoy {
    name: String,
    weight: f64,
}

let mut bois = vec![
    GoodBoy { name: "Pucci".to_owned(), weight: 0.1 },
    GoodBoy { name: "Woofer".to_owned(), weight: 99.0 },
    GoodBoy { name: "Yapper".to_owned(), weight: 10.0 },
    GoodBoy { name: "Chonk".to_owned(), weight: f64::INFINITY },
    GoodBoy { name: "Abs. Unit".to_owned(), weight: f64::NAN },
    GoodBoy { name: "Floaty".to_owned(), weight: -5.0 },
];

bois.sort_by(|a, b| a.weight.total_cmp(&b.weight));

// `f64::NAN` could be positive or negative, which will affect the sort order.
if f64::NAN.is_sign_negative() {
    assert!(bois.into_iter().map(|b| b.weight)
        .zip([f64::NAN, -5.0, 0.1, 10.0, 99.0, f64::INFINITY].iter())
        .all(|(a, b)| a.to_bits() == b.to_bits()))
} else {
    assert!(bois.into_iter().map(|b| b.weight)
        .zip([-5.0, 0.1, 10.0, 99.0, f64::INFINITY, f64::NAN].iter())
        .all(|(a, b)| a.to_bits() == b.to_bits()))
}

Trait Implementations

impl Add for Dollars

type Output = Dollars

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Dollars

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Bytes for Dollars

type Array = <f64 as Bytes>::Array

The byte array type returned by to_bytes. For fixed-size types, this is [u8; N] where N is the size of the type.

fn to_bytes(&self) -> Self::Array

Serializes this value to bytes.

fn from_bytes(bytes: &[u8]) -> Result<Self>

Deserializes a value from bytes.

const IS_NATIVE_LAYOUT: bool = false

Whether the byte representation from to_bytes is identical to the in-memory representation of Self. When true, bulk operations can use memcpy instead of per-element deserialization.

impl CheckedSub<usize> for Dollars

fn checked_sub(self, rhs: usize) -> Option<Self>

impl CheckedSub for Dollars

fn checked_sub(self, rhs: Self) -> Option<Self>

impl Clone for Dollars

fn clone(&self) -> Dollars

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dollars

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

Formats the value using the given formatter.

impl Default for Dollars

fn default() -> Dollars

Returns the “default value” for a type.

impl Deref for Dollars

type Target = f64

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Dollars

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Dollars

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

Formats the value using the given formatter.

impl Div<Bitcoin> for Dollars

type Output = Dollars

The resulting type after applying the / operator.

fn div(self, rhs: Bitcoin) -> Self::Output

Performs the / operation.

impl Div<Close<Dollars>> for Dollars

type Output = StoredF64

The resulting type after applying the / operator.

fn div(self, rhs: Close<Dollars>) -> Self::Output

Performs the / operation.

impl Div<Dollars> for Close<Dollars>

type Output = StoredF64

The resulting type after applying the / operator.

fn div(self, rhs: Dollars) -> Self::Output

Performs the / operation.

impl Div<Dollars> for Sats

type Output = Sats

The resulting type after applying the / operator.

fn div(self, rhs: Dollars) -> Self::Output

Performs the / operation.

impl Div<Dollars> for SatsFract

type Output = SatsFract

The resulting type after applying the / operator.

fn div(self, rhs: Dollars) -> Self::Output

Performs the / operation.

impl Div<Dollars> for StoredF32

type Output = StoredF32

The resulting type after applying the / operator.

fn div(self, rhs: Dollars) -> Self::Output

Performs the / operation.

impl Div<Dollars> for StoredF64

type Output = StoredF64

The resulting type after applying the / operator.

fn div(self, rhs: Dollars) -> Self::Output

Performs the / operation.

impl Div<StoredF64> for Dollars

type Output = Dollars

The resulting type after applying the / operator.

fn div(self, rhs: StoredF64) -> Self::Output

Performs the / operation.

impl Div<f64> for Dollars

type Output = Dollars

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> Self::Output

Performs the / operation.

impl Div<usize> for Dollars

type Output = Dollars

The resulting type after applying the / operator.

fn div(self, rhs: usize) -> Self::Output

Performs the / operation.

impl Div for Dollars

type Output = StoredF64

The resulting type after applying the / operator.

fn div(self, rhs: Dollars) -> Self::Output

Performs the / operation.

impl Formattable for Dollars

fn write_to(&self, buf: &mut Vec<u8>)

Write formatted UTF-8 bytes. Primary method — all others derive from it.

fn fmt_json(&self, buf: &mut Vec<u8>)

Write in JSON format. Override for types needing JSON wrapping (e.g., string quotes).

fn fmt_into(&self, f: &mut String)

Write to a String via write_to.

fn fmt_csv(&self, f: &mut String) -> Result<(), Error>

Write in CSV format. Override for types needing CSV escaping (e.g., quoting commas).

impl From<Cents> for Dollars

fn from(value: Cents) -> Self

Converts to this type from the input type.

impl From<CentsCompact> for Dollars

fn from(value: CentsCompact) -> Self

Converts to this type from the input type.

impl From<CentsSigned> for Dollars

fn from(value: CentsSigned) -> Self

Converts to this type from the input type.

impl From<Close<Dollars>> for Dollars

fn from(value: Close<Dollars>) -> Self

Converts to this type from the input type.

impl From<Dollars> for Cents

fn from(value: Dollars) -> Self

Converts to this type from the input type.

impl From<Dollars> for CentsCompact

fn from(value: Dollars) -> Self

Converts to this type from the input type.

impl From<Dollars> for CentsSigned

fn from(value: Dollars) -> Self

Converts to this type from the input type.

impl From<Dollars> for StoredF32

fn from(value: Dollars) -> Self

Converts to this type from the input type.

impl From<Dollars> for StoredF64

fn from(value: Dollars) -> Self

Converts to this type from the input type.

impl From<Dollars> for f32

fn from(value: Dollars) -> Self

Converts to this type from the input type.

impl From<Dollars> for f64

fn from(value: Dollars) -> Self

Converts to this type from the input type.

impl From<Dollars> for u128

fn from(value: Dollars) -> Self

Converts to this type from the input type.

impl From<High<Dollars>> for Dollars

fn from(value: High<Dollars>) -> Self

Converts to this type from the input type.

impl From<Low<Dollars>> for Dollars

fn from(value: Low<Dollars>) -> Self

Converts to this type from the input type.

impl From<Open<Dollars>> for Dollars

fn from(value: Open<Dollars>) -> Self

Converts to this type from the input type.

impl From<StoredF64> for Dollars

fn from(value: StoredF64) -> Self

Converts to this type from the input type.

impl From<f32> for Dollars

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Dollars

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<u128> for Dollars

fn from(value: u128) -> Self

Converts to this type from the input type.

impl From<u64> for Dollars

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<usize> for Dollars

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Hash for Dollars

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

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 JsonSchema for Dollars

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Mul<Bitcoin> for Dollars

type Output = Dollars

The resulting type after applying the * operator.

fn mul(self, rhs: Bitcoin) -> Self::Output

Performs the * operation.

impl Mul<Close<Dollars>> for Dollars

type Output = Dollars

The resulting type after applying the * operator.

fn mul(self, rhs: Close<Dollars>) -> Self::Output

Performs the * operation.

impl Mul<Dollars> for Close<Dollars>

type Output = Dollars

The resulting type after applying the * operator.

fn mul(self, rhs: Dollars) -> Self::Output

Performs the * operation.

impl Mul<Dollars> for StoredF64

type Output = StoredF64

The resulting type after applying the * operator.

fn mul(self, rhs: Dollars) -> Self::Output

Performs the * operation.

impl Mul<Sats> for Dollars

type Output = Dollars

The resulting type after applying the * operator.

fn mul(self, rhs: Sats) -> Self::Output

Performs the * operation.

impl Mul<StoredF32> for Dollars

type Output = Dollars

The resulting type after applying the * operator.

fn mul(self, rhs: StoredF32) -> Self::Output

Performs the * operation.

impl Mul<StoredF64> for Dollars

type Output = Dollars

The resulting type after applying the * operator.

fn mul(self, rhs: StoredF64) -> Self::Output

Performs the * operation.

impl Mul<f64> for Dollars

type Output = Dollars

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl Mul<i64> for Dollars

type Output = Dollars

The resulting type after applying the * operator.

fn mul(self, rhs: i64) -> Self::Output

Performs the * operation.

impl Mul<usize> for Dollars

type Output = Dollars

The resulting type after applying the * operator.

fn mul(self, rhs: usize) -> Self::Output

Performs the * operation.

impl Mul for Dollars

type Output = Dollars

The resulting type after applying the * operator.

fn mul(self, rhs: Dollars) -> Self::Output

Performs the * operation.

impl Neg for Dollars

type Output = Dollars

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Dollars

fn cmp(&self, other: &Self) -> 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,

Restrict a value to a certain interval.

impl PartialEq for Dollars

fn eq(&self, other: &Self) -> 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 PartialOrd for Dollars

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Pco for Dollars

type NumberType = <f64 as Pco>::NumberType

impl Serialize for Dollars

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Dollars

type Output = Dollars

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for Dollars

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Sum for Dollars

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for Dollars

impl Eq for Dollars

impl TransparentPco<<f64 as Pco>::NumberType> for Dollars