Skip to main content

GeneralPriceIndex

Struct GeneralPriceIndex 

Source
pub struct GeneralPriceIndex {
    pub currency: String,
    pub source: String,
    pub observations: Vec<(NaiveDate, Decimal)>,
}
Expand description

Time series of general-price-index (CPI) observations for a hyperinflationary economy. The index is monotonically non-decreasing in normal use; the lookup helpers tolerate out-of-order dates by sorting on access.

Fields§

§currency: String

ISO 4217 currency code the index applies to (e.g. “ARS”, “TRY”). Joins to entity functional currency for lookup.

§source: String

Source / methodology label (e.g. “INDEC IPC General”, “TÜİK CPI”). Carried for audit-trail purposes.

§observations: Vec<(NaiveDate, Decimal)>

Observed (date, index level) pairs. Index level convention: any positive Decimal — the helpers compute relative indexation factors (new / old), so absolute scale is free.

Implementations§

Source§

impl GeneralPriceIndex

Source

pub fn new(currency: impl Into<String>, source: impl Into<String>) -> Self

Construct an empty index for currency from a labelled source.

Source

pub fn observe(&mut self, date: NaiveDate, level: Decimal) -> &mut Self

Append an observation. Caller is responsible for ordering; Self::lookup sorts on access.

Source

pub fn lookup(&self, date: NaiveDate) -> Option<Decimal>

Look up the index level for a date. Returns the level on the most recent observation at or before date, mirroring the conservative IAS 29 convention of using the latest available CPI for each measurement date. Returns None when no observation exists at or before the date.

Source

pub fn indexation_factor( &self, from_date: NaiveDate, to_date: NaiveDate, ) -> Option<Decimal>

Compute the IAS 29 § 12 indexation factor for restating a historical-cost amount from from_date to to_date:

factor = index(to_date) / index(from_date)

Returns None when either lookup misses, or when the from_date index is zero (would otherwise divide-by-zero).

Trait Implementations§

Source§

impl Clone for GeneralPriceIndex

Source§

fn clone(&self) -> GeneralPriceIndex

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 GeneralPriceIndex

Source§

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

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

impl<'de> Deserialize<'de> for GeneralPriceIndex

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 PartialEq for GeneralPriceIndex

Source§

fn eq(&self, other: &GeneralPriceIndex) -> 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 GeneralPriceIndex

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 StructuralPartialEq for GeneralPriceIndex

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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, 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,