Struct UnexpectedFields

Source

pub struct UnexpectedFields<'buf>(/* private fields */);

Expand description

A collection of paths that were unexpected according to the schema used while parsing the JSON for an OCPI object.

Implementations§

Source §

impl<'buf> UnexpectedFields<'buf>

Source

pub fn to_strings(&self) -> Vec<String>

Return the field paths as a Vec of Strings.

Source

pub fn into_strings(self) -> Vec<String>

Return the field paths as a Vec of Strings.

Source

pub fn is_empty(&self) -> bool

Return true if the list of unexpected fields is empty.

Examples found in repository ?

examples/lint_tariff.rs (line 16)

6fn main() {
7    const TARIFF_JSON: &str =
8        include_str!("../test_data/v221/real_world/misspelled_field/tariff.json");
9
10    let report = tariff::parse_and_report(TARIFF_JSON).unwrap();
11    let guess::Report {
12        unexpected_fields,
13        version,
14    } = report;
15
16    if !unexpected_fields.is_empty() {
17        eprintln!("Strange... there are fields in the tariff that are not defined in the spec.");
18
19        for path in &unexpected_fields {
20            eprintln!("  * {path}");
21        }
22
23        eprintln!();
24    }
25
26    let tariff = version.certain_or(Version::V221);
27    let report = tariff::lint(&tariff).unwrap();
28
29    print_lint_warnings(&tariff, &report.into_warning_report());
30}

More examples

Hide additional examples

examples/price_cdr_with_known_version.rs (line 19)

8fn main() {
9    const CDR_JSON: &str =
10        include_str!("../test_data/v211/real_world/time_and_parking_time/cdr.json");
11
12    // If you know the version and timezone of a CDR you simply pass them into the `cdr::parse_with_version` fn.
13    let report = cdr::parse_with_version(CDR_JSON, Version::V211).expect("unable to parse CDR");
14    let cdr::ParseReport {
15        cdr,
16        unexpected_fields,
17    } = report;
18
19    if !unexpected_fields.is_empty() {
20        eprintln!("Strange... there are fields in the CDR that are not defined in the spec.");
21
22        for path in &unexpected_fields {
23            eprintln!("{path}");
24        }
25    }
26
27    let report = cdr::price(cdr, price::TariffSource::UseCdr, Tz::Europe__Amsterdam)
28        .expect("unable to price CDR JSON");
29
30    // The various fields of the `price::Report` can be examined or converted to JSON.
31    let price::Report {
32        warnings: _,
33        periods: _,
34        tariff: _,
35        tariff_reports: _,
36        timezone: _,
37        billed_energy: _,
38        billed_parking_time: _,
39        total_charging_time: _,
40        billed_charging_time: _,
41        total_cost: _,
42        total_fixed_cost: _,
43        total_time: _,
44        total_time_cost: _,
45        total_energy: _,
46        total_energy_cost: _,
47        total_parking_time: _,
48        total_parking_cost: _,
49        total_reservation_cost: _,
50    } = report;
51}

examples/price_cdr_with_unknown_version.rs (line 41)

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 v211.
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    let report = cdr::parse_with_version(CDR_JSON, Version::V211).expect("unable to parse CDR");
36    let cdr::ParseReport {
37        cdr,
38        unexpected_fields,
39    } = report;
40
41    if !unexpected_fields.is_empty() {
42        eprintln!("Strange... there are fields in the CDR that are not defined in the spec.");
43
44        for path in &unexpected_fields {
45            eprintln!("{path}");
46        }
47    }
48
49    let report =
50        cdr::price(cdr, price::TariffSource::UseCdr, timezone).expect("unable to price CDR JSON");
51
52    // The various fields of the `price::Report` can be examined or converted to JSON.
53    let price::Report {
54        warnings: _,
55        periods: _,
56        tariff: _,
57        tariff_reports: _,
58        timezone: _,
59        billed_energy: _,
60        billed_parking_time: _,
61        total_charging_time: _,
62        billed_charging_time: _,
63        total_cost: _,
64        total_fixed_cost: _,
65        total_time: _,
66        total_time_cost: _,
67        total_energy: _,
68        total_energy_cost: _,
69        total_parking_time: _,
70        total_parking_cost: _,
71        total_reservation_cost: _,
72    } = report;
73}