Struct Caveat

Source

pub struct Caveat<T, K: Kind> { /* private fields */ }

Expand description

A value that may have associated Warnings.

Even though the value has been created there may be certain caveats you should be aware of before using it.

Implementations§

Source §

impl<T, K> Caveat<T, K>
where K: Kind,

Source

pub fn into_parts(self) -> (T, Set<K>)

Return the value and any Warnings stored in the Caveat.

Examples found in repository ?

examples/price_cdr_with_unknown_version.rs (line 21)

6fn main() {
7    const CDR_JSON: &str =
8        include_str!("../test_data/v211/real_world/time_and_parking_time/cdr.json");
9
10    // First the raw JSON should be parsed into a `cdr::Versioned` object.
11    // The `cdr::Report` returned from calling `cdr::parse` contains a `cdr::Versioned` object
12    // and a potential list of unexpected fields based on the OCPI v221 spec.
13    let cdr = cdr::parse(CDR_JSON).expect("Unable to parse CDR JSON");
14
15    // The guessed Version can be either certain or uncertain.
16    // In this case we discard the CDR object and try convert it into a version.
17    // If the version is uncertain then fallback to presuming the CDR is v221.
18    let cdr = cdr.certain_or(Version::V211);
19
20    // The timezone can be inferred or found in the CDR, but a versioned CDR is required.
21    let (timezone_source, warnings) = timezone::find_or_infer(&cdr).into_parts();
22
23    let Some(timezone_source) = timezone_source else {
24        eprintln!("Unable to infer timezone");
25        print_timezone_warnings(&cdr, &warnings.into_report());
26        return;
27    };
28
29    if !warnings.is_empty() {
30        print_timezone_warnings(&cdr, &warnings.into_report());
31    }
32
33    // We don't care whether the timezone was found or inferred.
34    let timezone = timezone_source.into_timezone();
35
36    let report = cdr::price(
37        CDR_JSON,
38        price::TariffSource::UseCdr,
39        timezone,
40        Version::V211,
41    )
42    .expect("unable to price CDR JSON");
43
44    // The various fields of the `price::Report` can be examined or converted to JSON.
45    let price::Report {
46        warnings: _,
47        periods: _,
48        tariff_index: _,
49        tariff_id: _,
50        tariff_reports: _,
51        timezone: _,
52        billed_energy: _,
53        billed_parking_time: _,
54        total_charging_time: _,
55        billed_charging_time: _,
56        total_cost: _,
57        total_fixed_cost: _,
58        total_time: _,
59        total_time_cost: _,
60        total_energy: _,
61        total_energy_cost: _,
62        total_parking_time: _,
63        total_parking_cost: _,
64        total_reservation_cost: _,
65        unexpected_fields,
66    } = report;
67
68    if !unexpected_fields.is_empty() {
69        eprintln!("Strange... there are fields in the CDR that are not defined in the spec.");
70
71        for path in &unexpected_fields {
72            eprintln!("{path}");
73        }
74    }
75}