PriceAdjustment

Enum PriceAdjustment 

Source
pub enum PriceAdjustment {
    Tax {
        name: String,
        percentage: Decimal,
    },
    Discount {
        name: String,
        percentage: Decimal,
    },
    Fixed {
        name: String,
        amount: Decimal,
        currency: Currency,
    },
}
Expand description

Represents additional price modifications such as tax, discount, or fixed fees.

This enum is used to define adjustments that can be applied to a PricingDetail. These adjustments are later converted and applied using a CurrencyConverter, resulting in one or more AppliedAdjustment entries with actual values.

§Variants

  • Tax: Represents a tax to be applied as a percentage of the current sell price. Useful for applying VAT, Tax, or sales tax.

    • name: A human-readable label (e.g., "Tax 11%")
    • percentage: The tax rate as a percentage (e.g., 11.0 for 11%)
  • Discount: Represents a discount applied as a percentage of the current sell price. Useful for promotions or campaigns.

    • name: A human-readable label (e.g., "Promo New Year")
    • percentage: The discount rate as a percentage (e.g., 5.0 for 5%)
  • Fixed: Represents a fixed fee adjustment, such as a service or admin fee. This amount can be in a different currency and will be converted accordingly.

    Use sell_currency as the default currency for fixed amount adjustments. Caller is responsible for providing the correct currency context.

    • name: A human-readable label (e.g., "Admin Fee")
    • amount: The raw fixed amount before conversion
    • currency: The original currency of the fixed amount

§Example

use rust_decimal_macros::dec;
use pricing_kit::{Currency, PriceAdjustment};
let discount = PriceAdjustment::Discount {
    name: "Year End Promo".into(),
    percentage: dec!(5.0),
};

let tax = PriceAdjustment::Tax {
    name: "Tax 11%".into(),
    percentage: dec!(11.0),
};

let fixed_fee = PriceAdjustment::Fixed {
    name: "Admin Fee".into(),
    amount: dec!(2.0),
    currency: Currency::new("USD", "US Dollar"),
};

Adjustments are intended to be applied in order using PricingDetail::apply_adjustments().

Variants§

§

Tax

Fields

§name: String
§percentage: Decimal
§

Discount

Fields

§name: String
§percentage: Decimal
§

Fixed

Fields

§name: String
§amount: Decimal
§currency: Currency

Trait Implementations§

Source§

impl Clone for PriceAdjustment

Source§

fn clone(&self) -> PriceAdjustment

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PriceAdjustment

Source§

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

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

impl<'de> Deserialize<'de> for PriceAdjustment

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PriceAdjustment

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,