Struct PriceAnnotation 

pub struct PriceAnnotation {
    pub kind: PriceKind,
    pub amount: Option<IncompleteAmount>,
}

Price annotation for a posting (@ or @@).

Factored along its two orthogonal axes (#1167):

• kind: per-unit (@) vs total (@@)
• amount: present (possibly with missing number or currency that interpolation will fill) vs absent (the bare @/@@ sigil without any amount)

Pre-#1167 these axes were flattened into a 6-variant enum (Unit/Total/UnitIncomplete/TotalIncomplete/UnitEmpty/TotalEmpty), which forced every consumer to write six match arms even when only one axis mattered.

Fields

kind: PriceKind

Per-unit (@) or total (@@).

amount: Option<IncompleteAmount>

The price amount, or None for the bare-sigil form. IncompleteAmount::Complete indicates the parser saw a full number+currency; the other variants indicate one of those pieces was elided and will be filled by interpolation.

Implementations

impl PriceAnnotation

pub const fn unit(amount: Amount) -> Self

Per-unit (@) price with a complete amount.

pub const fn total(amount: Amount) -> Self

Total (@@) price with a complete amount.

pub const fn unit_incomplete(amount: IncompleteAmount) -> Self

Per-unit (@) price with an incomplete amount.

pub const fn total_incomplete(amount: IncompleteAmount) -> Self

Total (@@) price with an incomplete amount.

pub const fn unit_empty() -> Self

Bare per-unit sigil (@) with no amount.

pub const fn total_empty() -> Self

Bare total sigil (@@) with no amount.

pub fn amount(&self) -> Option<&Amount>

Get the complete amount if available.

pub const fn is_unit(&self) -> bool

Check if this is a per-unit price (@ vs @@).

Trait Implementations

impl Archive for PriceAnnotation

where PriceKind: Archive, Option<IncompleteAmount>: Archive,

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedPriceAnnotation

The archived representation of this type.

type Resolver = PriceAnnotationResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for PriceAnnotation

fn clone(&self) -> PriceAnnotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PriceAnnotation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PriceAnnotation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D: Fallible + ?Sized> Deserialize<PriceAnnotation, __D> for Archived<PriceAnnotation>

where PriceKind: Archive, <PriceKind as Archive>::Archived: Deserialize<PriceKind, __D>, Option<IncompleteAmount>: Archive, <Option<IncompleteAmount> as Archive>::Archived: Deserialize<Option<IncompleteAmount>, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<PriceAnnotation, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl Display for PriceAnnotation

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

Formats the value using the given formatter.

impl Eq for PriceAnnotation

impl PartialEq for PriceAnnotation

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PriceAnnotation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<__S: Fallible + ?Sized> Serialize<__S> for PriceAnnotation

where PriceKind: Serialize<__S>, Option<IncompleteAmount>: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl ShiftSpans for PriceAnnotation

fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F)

Apply shift to every Span reachable in self.

impl StructuralPartialEq for PriceAnnotation