Skip to main content

CostSpec

Struct CostSpec 

Source
pub struct CostSpec {
    pub number: Option<CostNumber>,
    pub currency: Option<Currency>,
    pub date: Option<NaiveDate>,
    pub label: Option<String>,
    pub merge: bool,
}
Expand description

A cost specification on a posting ({...} or {{...}}).

Carries the parsed cost-spec axes: the numeric component (per-unit vs total, modeled as the mutually-exclusive CostNumber enum), currency, lot date, label, and merge flag. Any subset may be missing — {} corresponds to all-fields-None plus merge: false, which lets the booker do lot matching deferred to inventory.

Pre-#1164 this struct had two independent Option<Decimal> fields (number_per, number_total). The mutual-exclusion invariant was enforced only by parser discipline; the post-booking “derived per- unit from total” state was modeled accidentally by setting both fields at once. The new shape (number: Option<CostNumber>) makes the invalid state unrepresentable and the derived state explicit.

Fields§

§number: Option<CostNumber>

The numeric component: per-unit, total, or absent.

Replaces the pre-#1164 number_per / number_total pair, which allowed the invalid both-set state at the type level. See CostNumber for the per-unit vs total distinction.

§currency: Option<Currency>

Currency of the cost (if specified)

§date: Option<NaiveDate>

Acquisition date (if specified)

§label: Option<String>

Lot label (if specified)

§merge: bool

Whether to merge with existing lot (average cost)

Implementations§

Source§

impl CostSpec

Source

pub fn empty() -> Self

Create an empty cost spec.

Source

pub const fn with_number(self, number: CostNumber) -> Self

Set the cost number directly.

The mutual exclusion between per-unit and total is enforced by the CostNumber enum — there is no way to set both. Callers construct the variant explicitly:

CostSpec::empty().with_number(CostNumber::PerUnit { value: dec!(150) });
CostSpec::empty().with_number(CostNumber::Total { value: dec!(1500) });

Pre-#1164 this slot was a pair of Option<Decimal> fields; pre-this-PR there were with_per_unit / with_total convenience shims that perpetuated the two-axis mental model in caller code and silently overwrote each other if both were called. Both are gone — there’s exactly one way to set a cost number now.

Source

pub fn with_currency(self, currency: impl Into<Currency>) -> Self

Set the currency.

Source

pub const fn with_date(self, date: NaiveDate) -> Self

Set the date.

Source

pub fn with_label(self, label: impl Into<String>) -> Self

Set the label.

Source

pub const fn with_merge(self) -> Self

Set the merge flag (for average cost booking).

Source

pub const fn is_empty(&self) -> bool

Check if this is an empty cost spec (all fields None).

Source

pub fn matches(&self, cost: &Cost) -> bool

Check if this cost spec matches a cost.

All specified fields must match the corresponding cost fields. Per-unit matching uses CostNumber::per_unit() — a Total-only spec doesn’t constrain the per-unit lot value (booking hasn’t resolved it yet), but a PerUnitFromTotal post-booking spec does.

Source

pub fn resolve(&self, units: Decimal, date: NaiveDate) -> Option<Cost>

Resolve this cost spec to a concrete cost, given the number of units.

If the number is CostNumber::Total, the per-unit cost is calculated as total / |units|. Full precision is preserved to avoid cost basis errors when the position is later sold. PerUnitFromTotal already carries the derived per-unit value from a prior booking pass — using b.per_unit directly is equivalent to recomputing b.total / |units| because BookedCost::new enforces that invariant at construction.

Returns None if required fields (currency, number) are missing.

Trait Implementations§

Source§

impl Archive for CostSpec

Source§

type Archived = ArchivedCostSpec

The archived representation of this type. Read more
Source§

type Resolver = CostSpecResolver

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

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

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

impl Clone for CostSpec

Source§

fn clone(&self) -> CostSpec

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 CostSpec

Source§

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

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

impl Default for CostSpec

Source§

fn default() -> CostSpec

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CostSpec

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<__D: Fallible + ?Sized> Deserialize<CostSpec, __D> for Archived<CostSpec>

Source§

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

Deserializes using the given deserializer
Source§

impl Display for CostSpec

Source§

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

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

impl Eq for CostSpec

Source§

impl Hash for CostSpec

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CostSpec

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for CostSpec

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

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

Source§

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

impl ShiftSpans for CostSpec

Source§

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

Apply shift to every Span reachable in self.
Source§

impl StructuralPartialEq for CostSpec

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> ArchiveUnsized for T
where T: Archive,

Source§

type Archived = <T as Archive>::Archived

The archived counterpart of this type. Unlike Archive, it may be unsized. Read more
Source§

fn archived_metadata( &self, ) -> <<T as ArchiveUnsized>::Archived as ArchivePointee>::ArchivedMetadata

Creates the archived version of the metadata for this value.
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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T, S> SerializeUnsized<S> for T
where T: Serialize<S>, S: Fallible + Writer + ?Sized,

Source§

fn serialize_unsized( &self, serializer: &mut S, ) -> Result<usize, <S as Fallible>::Error>

Writes the object and returns the position of the archived type.
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.