brk_structs 0.0.111

Structs used throughout BRK
Documentation
use std::{
    cmp::Ordering,
    f64,
    iter::Sum,
    ops::{Add, AddAssign, Div, Mul},
};

use allocative::Allocative;
use derive_deref::Deref;
use serde::{Deserialize, Serialize};
use vecdb::{CheckedSub, StoredCompressed};
use zerocopy_derive::{FromBytes, Immutable, IntoBytes, KnownLayout};

use crate::{Low, Open};

use super::{Bitcoin, Cents, Close, High, Sats, StoredF32, StoredF64};

#[derive(
    Debug,
    Default,
    Clone,
    Copy,
    Deref,
    FromBytes,
    Immutable,
    IntoBytes,
    KnownLayout,
    Serialize,
    Deserialize,
    StoredCompressed,
    Allocative,
)]
pub struct Dollars(f64);

impl Dollars {
    pub const ZERO: Self = Self(0.0);
    pub const NAN: Self = Self(f64::NAN);

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

    pub fn round_nearest_cent(self) -> Self {
        Dollars((self.0 * 100.0).round() / 100.0)
    }

    pub fn round_to(self, digits: i32) -> Self {
        Self::from(Cents::from(self).round_to(digits))
    }

    pub fn is_negative(&self) -> bool {
        self.0 < 0.0
    }
}

impl From<f32> for Dollars {
    fn from(value: f32) -> Self {
        Self(value as f64)
    }
}

impl From<f64> for Dollars {
    fn from(value: f64) -> Self {
        Self(value)
    }
}

impl From<Cents> for Dollars {
    fn from(value: Cents) -> Self {
        Self(f64::from(value) / 100.0)
    }
}

impl From<Dollars> for f32 {
    fn from(value: Dollars) -> Self {
        value.0 as f32
    }
}

impl From<Dollars> for f64 {
    fn from(value: Dollars) -> Self {
        value.0
    }
}

impl From<Open<Dollars>> for Dollars {
    fn from(value: Open<Dollars>) -> Self {
        *value
    }
}

impl From<High<Dollars>> for Dollars {
    fn from(value: High<Dollars>) -> Self {
        *value
    }
}

impl From<Low<Dollars>> for Dollars {
    fn from(value: Low<Dollars>) -> Self {
        *value
    }
}

impl From<Close<Dollars>> for Dollars {
    fn from(value: Close<Dollars>) -> Self {
        *value
    }
}

impl From<usize> for Dollars {
    fn from(value: usize) -> Self {
        Self(value as f64)
    }
}

impl Add for Dollars {
    type Output = Self;
    fn add(self, rhs: Self) -> Self::Output {
        Self::from(Cents::from(self) + Cents::from(rhs))
    }
}

impl Div<Dollars> for Dollars {
    type Output = StoredF64;
    fn div(self, rhs: Dollars) -> Self::Output {
        if self.is_nan() || rhs == Dollars::ZERO {
            StoredF64::NAN
        } else {
            StoredF64::from(f64::from(self) / f64::from(rhs))
        }
    }
}

impl Div<Close<Dollars>> for Dollars {
    type Output = StoredF64;
    fn div(self, rhs: Close<Dollars>) -> Self::Output {
        if self.is_nan() || *rhs == Dollars::ZERO {
            StoredF64::NAN
        } else {
            StoredF64::from(f64::from(self) / f64::from(*rhs))
        }
    }
}

impl Div<Dollars> for Close<Dollars> {
    type Output = StoredF64;
    fn div(self, rhs: Dollars) -> Self::Output {
        if self.is_nan() || rhs == Dollars::ZERO {
            StoredF64::NAN
        } else {
            StoredF64::from(f64::from(*self) / f64::from(rhs))
        }
    }
}

impl Div<usize> for Dollars {
    type Output = Self;
    fn div(self, rhs: usize) -> Self::Output {
        if self.is_nan() || rhs == 0 {
            Dollars::NAN
        } else {
            Self::from(Cents::from(self) / rhs)
        }
    }
}

impl Div<StoredF64> for Dollars {
    type Output = Self;
    fn div(self, rhs: StoredF64) -> Self::Output {
        self / f64::from(rhs)
    }
}

impl Div<f64> for Dollars {
    type Output = Self;
    fn div(self, rhs: f64) -> Self::Output {
        if self.is_nan() || rhs == 0.0 {
            Dollars::NAN
        } else {
            Dollars::from(Cents::from(Self::from(self.0 / rhs)))
        }
    }
}

impl Div<Bitcoin> for Dollars {
    type Output = Self;
    fn div(self, rhs: Bitcoin) -> Self::Output {
        if self.is_nan() {
            self
        } else {
            Self(f64::from(self) / f64::from(rhs))
        }
    }
}

impl Mul<Dollars> for Dollars {
    type Output = Self;
    fn mul(self, rhs: Dollars) -> Self::Output {
        Self::from(Cents::from(self) * Cents::from(rhs))
    }
}

impl Mul<Close<Dollars>> for Dollars {
    type Output = Self;
    fn mul(self, rhs: Close<Dollars>) -> Self::Output {
        Self::from(Cents::from(self) * Cents::from(*rhs))
    }
}

impl Mul<Dollars> for Close<Dollars> {
    type Output = Dollars;
    fn mul(self, rhs: Dollars) -> Self::Output {
        Dollars::from(Cents::from(*self) * Cents::from(rhs))
    }
}

impl Mul<usize> for Close<Dollars> {
    type Output = Dollars;
    fn mul(self, rhs: usize) -> Self::Output {
        Dollars::from(Cents::from(*self) * rhs)
    }
}

impl Mul<StoredF64> for Close<Dollars> {
    type Output = Dollars;
    fn mul(self, rhs: StoredF64) -> Self::Output {
        *self * rhs
    }
}

impl Mul<f64> for Dollars {
    type Output = Dollars;
    fn mul(self, rhs: f64) -> Self::Output {
        if rhs.fract() != 0.0 {
            Self::from(self.0 * rhs)
        } else {
            self * rhs as i64
        }
    }
}

impl Mul<Bitcoin> for Dollars {
    type Output = Self;
    fn mul(self, rhs: Bitcoin) -> Self::Output {
        self * Sats::from(rhs)
    }
}

impl Mul<Bitcoin> for Close<Dollars> {
    type Output = Dollars;
    fn mul(self, rhs: Bitcoin) -> Self::Output {
        *self * Sats::from(rhs)
    }
}

impl Mul<Sats> for Dollars {
    type Output = Self;
    fn mul(self, rhs: Sats) -> Self::Output {
        if self.is_nan() {
            self
        } else {
            Self::from(Cents::from(
                u128::from(rhs) * u128::from(Cents::from(self)) / Sats::ONE_BTC_U128,
            ))
        }
    }
}

impl Mul<StoredF32> for Dollars {
    type Output = Self;
    fn mul(self, rhs: StoredF32) -> Self::Output {
        self * *rhs as f64
    }
}

impl Mul<StoredF64> for Dollars {
    type Output = Self;
    fn mul(self, rhs: StoredF64) -> Self::Output {
        self * *rhs
    }
}

impl Mul<i64> for Dollars {
    type Output = Self;
    fn mul(self, rhs: i64) -> Self::Output {
        Self::from(Cents::from(self) * rhs)
    }
}

impl Mul<usize> for Dollars {
    type Output = Self;
    fn mul(self, rhs: usize) -> Self::Output {
        if self.is_nan() {
            self
        } else {
            Self::from(Cents::from(self) * rhs)
        }
    }
}

impl From<u128> for Dollars {
    fn from(value: u128) -> Self {
        Self::from(Cents::from(value))
    }
}

impl From<StoredF64> for Dollars {
    fn from(value: StoredF64) -> Self {
        Self(*value)
    }
}

impl From<Close<Dollars>> for u128 {
    fn from(value: Close<Dollars>) -> Self {
        u128::from(*value)
    }
}

impl From<Dollars> for u128 {
    fn from(value: Dollars) -> Self {
        u128::from(Cents::from(value))
    }
}

impl AddAssign for Dollars {
    fn add_assign(&mut self, rhs: Self) {
        *self = Dollars::from(Cents::from(*self) + Cents::from(rhs));
    }
}

impl CheckedSub for Dollars {
    fn checked_sub(self, rhs: Self) -> Option<Self> {
        if self.is_nan() {
            Some(self)
        } else {
            Cents::from(self)
                .checked_sub(Cents::from(rhs))
                .map(Dollars::from)
        }
    }
}

impl CheckedSub<usize> for Dollars {
    fn checked_sub(self, rhs: usize) -> Option<Self> {
        Some(Dollars::from(
            Cents::from(self).checked_sub(Cents::from(rhs)).unwrap(),
        ))
    }
}

impl PartialEq for Dollars {
    fn eq(&self, other: &Self) -> bool {
        match (self.0.is_nan(), other.0.is_nan()) {
            (true, true) => true,
            (true, false) => false,
            (false, true) => false,
            (false, false) => self.0 == other.0,
        }
    }
}

impl Eq for Dollars {}

#[allow(clippy::derive_ord_xor_partial_ord)]
impl PartialOrd for Dollars {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

#[allow(clippy::derive_ord_xor_partial_ord)]
impl Ord for Dollars {
    fn cmp(&self, other: &Self) -> Ordering {
        match (self.0.is_nan(), other.0.is_nan()) {
            (true, true) => Ordering::Equal,
            (true, false) => Ordering::Less,
            (false, true) => Ordering::Greater,
            (false, false) => self.0.partial_cmp(&other.0).unwrap(),
        }
    }
}

impl Sum for Dollars {
    fn sum<I: Iterator<Item = Self>>(iter: I) -> Self {
        let dollars: f64 = iter.map(|dollars| dollars.0).sum();
        Self::from(dollars)
    }
}

impl std::fmt::Display for Dollars {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let mut buf = ryu::Buffer::new();
        let str = buf.format(self.0);
        f.write_str(str)
    }
}