Skip to main content

Price

Struct Price 

Source
pub struct Price {
    pub net: CurrencyAmount,
    pub tax_rate: Decimal,
}
Expand description

A net price plus a percentage tax rate (e.g. VAT 20%).

All amounts share a single Currency; operations return MoneyError::CurrencyMismatch if currencies diverge.

Mirrors ecom_core::Money::percentage_oftax = net * rate / 100 — but surfaces the rate explicitly for invoicing.

use billing_kit::{Price, Currency};
use rust_decimal_macros::dec;
let p = Price::new(dec!(100), Currency::GBP, dec!(20)).unwrap();
assert_eq!(p.tax_amount().amount, dec!(20));
assert_eq!(p.gross().amount, dec!(120));

Fields§

§net: CurrencyAmount

Net (pre-tax) amount.

§tax_rate: Decimal

Tax rate as percentage (0-100).

Implementations§

Source§

impl Price

Source

pub fn new( net_amount: impl Into<Decimal>, currency: Currency, tax_rate: Decimal, ) -> Result<Self, PriceError>

Create a new Price.

§Errors

Returns PriceError::InvalidTaxRate if tax_rate is not in 0..=100.

Source

pub fn tax_amount(&self) -> CurrencyAmount

Tax amount = net * tax_rate / 100.

Source

pub fn gross(&self) -> CurrencyAmount

Gross amount = net + tax.

Source

pub fn discount_of_gross(&self, percent: Decimal) -> CurrencyAmount

Discount amount at percent% of gross (0-100).

Source

pub fn gross_minus_discount(&self, percent: Decimal) -> CurrencyAmount

Apply a promo discount to gross, returning the discounted gross.

Clamps percent to 0..=100 and never returns a negative amount.

Trait Implementations§

Source§

impl Clone for Price

Source§

fn clone(&self) -> Price

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Price

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Price

Source§

impl PartialEq for Price

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Price

Auto Trait Implementations§

§

impl Freeze for Price

§

impl RefUnwindSafe for Price

§

impl Send for Price

§

impl Sync for Price

§

impl Unpin for Price

§

impl UnsafeUnpin for Price

§

impl UnwindSafe for Price

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.