Struct costoflife::TxRecord

source · [−]

pub struct TxRecord { /* private fields */ }

Implementations

source

impl TxRecord

Holds a transaction informations

source

pub fn get_name(&self) -> &str

source

pub fn get_tags(&self) -> Vec<String>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get the tags for the tx, sorted alphabetically

source

pub fn get_amount(&self) -> BigDecimal

Get the amount for the tx, rounded to 2 decimals

source

pub fn get_lifetime(&self) -> &Lifetime

Get the lifetime for the tx

source

pub fn get_starts_on(&self) -> NaiveDate

Get the start date for the tx

source

pub fn get_recorded_at(&self) -> &DateTime<FixedOffset>

Get the datetime when the tx was recorded

source

pub fn get_recorded_at_rfc3339(&self) -> String

Get the datetime when the tx was recorded as a rfc3339 string

source

pub fn amount_is_total(&self) -> bool

Returns true if the base amount is the same as the total

That is, when there is no repetition on the lifetime

source

pub fn has_tag(&self, tag: &str) -> bool

Tells if the TxRecord as a tag

source

pub fn get_amount_total(&self) -> BigDecimal

Returns total amount for the transaction record

source

pub fn get_duration_days(&self) -> i64

Returns the duration in days for this transaction

source

pub fn per_diem(&self) -> BigDecimal

Calculates and returns the per diem for the record and round it to the 2 decimals

source

pub fn per_diem_raw(&self) -> BigDecimal

Calculates and returns the per diem for the record

The per diem is calculated as follow:

END_DAY = START_DAY + (RECURRENCE_SIZE_DAYS * SEC_IN_DAYS * RECURRENCE_TIMES)
PER_DIEM = AMOUNT * RECURRENCE_TIMES) / (END_DAY - START_DAY )

source

pub fn get_progress(&self, d: Option<NaiveDate>) -> f32

Get the progress of the transaction at date

None will use today as a data

source

pub fn get_ends_on(&self) -> NaiveDate

Returns the end date (always computed)

source

pub fn is_active_on(&self, target: &NaiveDate) -> bool

source

pub fn to_string_record(&self) -> String

Serialize the record to its string format

source

pub fn from_string_record(s: &str) -> Result<TxRecord, CostOfLifeError>

source

pub fn new(name: &str, amount: &str) -> Result<TxRecord, CostOfLifeError>

source

pub fn from(
 name: &str,
 tags: Vec<&str>,
 amount: &str,
 starts_on: NaiveDate,
 lifetime: Lifetime,
 recorded_at: DateTime<FixedOffset>,
 src: Option<&str>
) -> Result<TxRecord, CostOfLifeError>

Builds a TxRecord using parameters

Arguments

name - A string slice that holds the name of the transaction
tags - A vector of string slices with the transaction’s tags
amount - A string slice representing a monetary value
starts_on - The date of the start of the transaction
lifetime - The lifetime of transaction
recorded_at - The localized exact time when the tx was added
src - An option string slice with the original string used to submit the tx

Examples

use costoflife::{self, TxRecord, Lifetime};

let tx = TxRecord::from(
    "Car",
    vec!["transportation", "lifestyle"],
    "100000",
    costoflife::date(01, 01, 2010),
    Lifetime::Year {
        amount: 20,
        times: 1,
    },
    costoflife::now_local(),
    None,
).unwrap();