retiretui_engine 0.2.0

Plan model, tax engine, and projection for RetireTui.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

use serde::Serialize;
use serde::de::DeserializeOwned;
use toml::Table;

use super::PlanError;

/// A plan value as a TOML table. Both directions go through TOML text:
/// `toml::Value`'s in-memory (de)serializers stringify datetimes, so a
/// direct conversion loses dates.
///
/// # Errors
///
/// Returns [`PlanError`] when the value does not serialize to a table.
pub fn to_table<T: Serialize>(value: &T) -> Result<Table, PlanError> {
    Ok(toml::to_string(value)?.parse()?)
}

/// The plan value a table describes, through TOML text as [`to_table`].
///
/// # Errors
///
/// Returns [`PlanError`] when the table does not match `T`'s schema.
pub fn from_table<T: DeserializeOwned>(table: &Table) -> Result<T, PlanError> {
    Ok(toml::from_str(&toml::to_string(table)?)?)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::plan::PlanDate;

    #[test]
    fn a_date_survives_the_round_trip() {
        #[derive(Serialize, serde::Deserialize, PartialEq, Debug)]
        struct Dated {
            on: PlanDate,
        }
        let dated = Dated {
            on: PlanDate(jiff::civil::date(2030, 6, 15)),
        };
        assert_eq!(
            from_table::<Dated>(&to_table(&dated).unwrap()).unwrap(),
            dated
        );
    }
}