Struct CostBreakdown 

pub struct CostBreakdown {
    pub dimensions: Vec<DimensionCost>,
    pub total_excl_vat: Number,
    pub total_incl_vat: Number,
    pub taxes: Vec<TaxLine>,
    pub limit_applied: Option<PriceLimitApplied>,
    pub notes: Vec<PricingNote>,
}

Available on crate feature tariffs only.

The complete, auditable result of pricing a session.

for dimension in &breakdown.dimensions {
    println!(
        "{:>12} {:>8} billed (measured {:>8}) = {}",
        dimension.dimension, dimension.billed, dimension.measured, dimension.cost,
    );
    for segment in &dimension.segments {
        println!("             via {}", segment.applied);
    }
}
println!("total {} ({} incl. VAT)", breakdown.total_excl_vat, breakdown.total_incl_vat);

Fields

dimensions: Vec<DimensionCost>

What each dimension cost.

total_excl_vat: Number

The total excluding VAT, after any min_price/max_price clamp.

total_incl_vat: Number

The total including VAT, after any clamp.

taxes: Vec<TaxLine>

The VAT owed, grouped by percentage.

limit_applied: Option<PriceLimitApplied>

Whether a min_price or max_price changed the total.

notes: Vec<PricingNote>

Anything the reader of this breakdown should know: see PricingNoteCode.

Empty is the ordinary case. A note is never an error — the total beside it is the engine’s best answer — but every one of them is a reason to look, and most of them are defects in the input rather than in the tariff.

Implementations

impl CostBreakdown

pub fn dimension( &self, dimension: TariffDimensionType, ) -> Option<&DimensionCost>

The cost of one dimension, if it was priced.

pub fn dimension_total(&self, dimension: TariffDimensionType) -> Number

The total for one dimension, or zero if it was not priced.

pub fn total_vat(&self) -> Number

The total VAT across all dimensions.

Always equal to total_incl_vat - total_excl_vat; see TaxLine.

pub fn notes_with( &self, code: PricingNoteCode, ) -> impl Iterator<Item = &PricingNote>

The notes carrying code.

pub fn needs_review(&self) -> bool

Whether anything about this session needs a human’s attention.

True when the breakdown carries any note at all. A reconciliation pipeline can use this to split a month’s CDRs into the ones that priced cleanly and the ones that did not.

pub fn applied_components(&self) -> impl Iterator<Item = &AppliedComponent>

Every Price Component that contributed, in the order they were applied.

pub fn to_price_v2_3_0(&self) -> Price

Available on crate feature v2_3_0 only.

The result as an OCPI 2.3.0 Price.

The VAT lines become TaxAmounts named VAT, one per distinct percentage, which is what a Tariff’s per-component vat fields describe.

pub fn to_price_v2_2_1(&self) -> Price

Available on crate feature v2_2_1 only.

The result as an OCPI 2.2.1 Price.

Trait Implementations

impl Clone for CostBreakdown

fn clone(&self) -> CostBreakdown

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CostBreakdown

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CostBreakdown

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CostBreakdown

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

The whole breakdown, including its notes.

The notes are the part somebody has to act on, so they are not something the default rendering may quietly leave out. An engine that records a finding and then prints a total as if nothing happened is worse than one that never looked.

impl PartialEq for CostBreakdown

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CostBreakdown

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CostBreakdown