Enum Amount 

pub enum Amount {
    Estimated(EstimatedUsd),
    Unpriced {
        reason: String,
    },
}

What a line item’s cost can be (COST-3).

Any consumer that matches on this has to handle the unknown case, which is the property the whole module rests on. Amount::Unpriced is distinct from Amount::Estimated(EstimatedUsd::ZERO) on purpose: zero is a claim about the bill, unpriced is a claim about the documentation.

Variants

Estimated(EstimatedUsd)

Unpriced

A quantity we can measure but cannot price, because no rate is published.

The reason is a field and not optional, so the line item can say why rather than just that it cannot. BUILD_UNPRICED_REASON is the one this module raises.

Fields

reason: String

Implementations

impl Amount

pub fn estimated(amount: Decimal) -> Amount

A priced amount from a decimal figure.

pub fn unpriced(reason: impl Into<String>) -> Amount

An unpriced amount, with the reason that goes on the line item.

pub fn estimate(&self) -> Option<EstimatedUsd>

The estimate, when there is one.

Returns Option rather than defaulting to zero, which is the same decision as cli.py’s JSON omitting the usd key entirely for an unpriced line: a null gets summed as zero by anything permissive, and that is the one arithmetic this module refuses to enable.

pub fn unpriced_reason(&self) -> Option<&str>

The reason this could not be priced, when it could not.

pub fn kind(&self) -> &'static str

The stable tag cli.py puts in the JSON envelope’s amount.kind.

Trait Implementations

impl Clone for Amount

fn clone(&self) -> Amount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Amount

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

Formats the value using the given formatter.

impl Display for Amount

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

Formats the value using the given formatter.

impl Eq for Amount

impl PartialEq for Amount

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Amount