Struct Cost 

pub struct Cost {
    pub number: Decimal,
    pub currency: InternedStr,
    pub date: Option<NaiveDate>,
    pub label: Option<String>,
}

A cost represents the acquisition cost of a position (lot).

When you buy 10 shares of AAPL at $150 on 2024-01-15, the cost is:

• number: 150
• currency: “USD”
• date: Some(2024-01-15)
• label: None (or Some(“lot1”) if labeled)

Examples

use rustledger_core::Cost;
use rust_decimal_macros::dec;
use chrono::NaiveDate;

let cost = Cost::new(dec!(150.00), "USD")
    .with_date(NaiveDate::from_ymd_opt(2024, 1, 15).unwrap());

assert_eq!(cost.number, dec!(150.00));
assert_eq!(cost.currency, "USD");
assert!(cost.date.is_some());

Fields

number: Decimal

Cost per unit

currency: InternedStr

Currency of the cost

date: Option<NaiveDate>

Acquisition date (optional, for lot identification)

label: Option<String>

Lot label (optional, for explicit lot identification)

Implementations

impl Cost

pub fn new(number: Decimal, currency: impl Into<InternedStr>) -> Self

Create a new cost with the given number and currency.

Create a new cost with exact precision. Use this for user-specified values that should preserve their precision.

pub fn new_calculated(number: Decimal, currency: impl Into<InternedStr>) -> Self

Create a new cost for calculated values.

Previously this auto-quantized, but we now preserve full precision to avoid cost basis errors. Rounding should only happen at display time.

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

Add a date to this cost.

pub const fn with_date_opt(self, date: Option<NaiveDate>) -> Self

Add an optional date to this cost.

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

Add a label to this cost.

pub fn with_label_opt(self, label: Option<String>) -> Self

Add an optional label to this cost.

pub fn as_amount(&self) -> Amount

Get the cost as an amount.

pub fn total_cost(&self, units: Decimal) -> Amount

Calculate the total cost for a given number of units.

Trait Implementations

impl Archive for Cost

where AsDecimal: ArchiveWith<Decimal>, AsInternedStr: ArchiveWith<InternedStr>, Map<AsNaiveDate>: ArchiveWith<Option<NaiveDate>>, Option<String>: Archive,

type Archived = ArchivedCost

The archived representation of this type.

type Resolver = CostResolver

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.

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.

impl Clone for Cost

fn clone(&self) -> Cost

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cost

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Cost

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<Cost, __D> for Archived<Cost>

where AsDecimal: ArchiveWith<Decimal> + DeserializeWith<<AsDecimal as ArchiveWith<Decimal>>::Archived, Decimal, __D>, AsInternedStr: ArchiveWith<InternedStr> + DeserializeWith<<AsInternedStr as ArchiveWith<InternedStr>>::Archived, InternedStr, __D>, Map<AsNaiveDate>: ArchiveWith<Option<NaiveDate>> + DeserializeWith<<Map<AsNaiveDate> as ArchiveWith<Option<NaiveDate>>>::Archived, Option<NaiveDate>, __D>, Option<String>: Archive, <Option<String> as Archive>::Archived: Deserialize<Option<String>, __D>,

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

Deserializes using the given deserializer

impl Display for Cost

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

Formats the value using the given formatter.

impl Hash for Cost

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Cost

fn eq(&self, other: &Cost) -> 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<__S: Fallible + ?Sized> Serialize<__S> for Cost

where AsDecimal: SerializeWith<Decimal, __S>, AsInternedStr: SerializeWith<InternedStr, __S>, Map<AsNaiveDate>: SerializeWith<Option<NaiveDate>, __S>, Option<String>: 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 Serialize for Cost

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Cost

impl StructuralPartialEq for Cost