Struct Set

Source

pub struct Set<W: Warning>(/* private fields */);

Expand description

A set of Warnings transported through the system using a Caveat.

Implementations§

Source §

impl<W: Warning> Set<W>

Source

pub fn is_empty(&self) -> bool

Return true if the Warning set is empty.

Examples found in repository ?

examples/generate_cdr_from_tariff.rs (line 74)

73fn print_warnings(warnings: &warning::Set<generate::Warning>) {
74    if warnings.is_empty() {
75        return;
76    }
77
78    eprintln!(
79        "WARN: {} warnings from the linting:\n {}",
80        warnings.len_warnings(),
81        warning::SetWriter::new(warnings)
82    );
83}

More examples

Hide additional examples

examples/price_cdr_with_known_version.rs (line 71)

70fn print_pricing_warnings(warnings: &warning::Set<price::Warning>) {
71    if warnings.is_empty() {
72        return;
73    }
74
75    eprintln!(
76        "WARN: {} warnings from the pricing:\n {}",
77        warnings.len_warnings(),
78        warning::SetWriter::new(warnings)
79    );
80}

examples/lint_tariff.rs (line 33)

32fn print_lint_warnings(warnings: &warning::Set<lint::tariff::Warning>) {
33    if warnings.is_empty() {
34        return;
35    }
36
37    eprintln!(
38        "WARN: {} warnings from the linting:\n {}",
39        warnings.len_warnings(),
40        warning::SetWriter::new(warnings)
41    );
42}

examples/price_cdr_with_unknown_version.rs (line 33)

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 to 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 = match timezone::find_or_infer(&cdr) {
22        Ok(tz) => tz,
23        Err(err_set) => {
24            let (error, warnings) = err_set.into_parts();
25            eprintln!("Unable to infer timezone");
26            print_timezone_error(&error);
27            print_timezone_warnings(&warnings);
28            return;
29        }
30    };
31    let (timezone_source, warnings) = timezone.into_parts();
32
33    if !warnings.is_empty() {
34        print_timezone_warnings(&warnings);
35    }
36
37    // We don't care whether the timezone was found or inferred.
38    let timezone = timezone_source.into_timezone();
39    let report = cdr::parse_with_version(CDR_JSON, Version::V211).expect("Unable to parse CDR");
40    let cdr::ParseReport {
41        cdr,
42        unexpected_fields,
43    } = report;
44
45    if !unexpected_fields.is_empty() {
46        eprintln!("Strange... there are fields in the CDR that are not defined in the spec.");
47
48        for path in &unexpected_fields {
49            eprintln!("{path}");
50        }
51    }
52
53    let report = match cdr::price(&cdr, price::TariffSource::UseCdr, timezone) {
54        Ok(r) => r,
55        Err(set) => {
56            let (error, warnings) = set.into_parts();
57            print_pricing_error(&error);
58            print_pricing_warnings(&warnings);
59            return;
60        }
61    };
62
63    let (report, warnings) = report.into_parts();
64
65    print_pricing_warnings(&warnings);
66
67    // The various fields of the `price::Report` can be examined or converted to JSON.
68    let price::Report {
69        periods: _,
70        tariff_used: _,
71        tariff_reports: _,
72        timezone: _,
73        billed_energy: _,
74        billed_parking_time: _,
75        total_charging_time: _,
76        billed_charging_time: _,
77        total_cost: _,
78        total_fixed_cost: _,
79        total_time: _,
80        total_time_cost: _,
81        total_energy: _,
82        total_energy_cost: _,
83        total_parking_time: _,
84        total_parking_cost: _,
85        total_reservation_cost: _,
86    } = report;
87}
88
89fn print_timezone_error(error: &warning::Error<timezone::Warning>) {
90    eprintln!(
91        "ERR: Unable to find timezone due to error at path `{}`: {}",
92        error.element().path,
93        error.warning()
94    );
95}
96
97fn print_timezone_warnings(warnings: &warning::Set<timezone::Warning>) {
98    if warnings.is_empty() {
99        return;
100    }
101
102    eprintln!(
103        "WARN: {} warnings from the timezone search",
104        warnings.len_warnings()
105    );
106
107    eprintln!(
108        "WARN: {} warnings from the timezone search:\n {}",
109        warnings.len_warnings(),
110        warning::SetWriter::new(warnings)
111    );
112}
113
114fn print_pricing_error(error: &warning::Error<price::Warning>) {
115    eprintln!(
116        "ERR: Unable to price CDR due to error at path `{}`: {}",
117        error.element().path,
118        error.warning()
119    );
120}
121
122fn print_pricing_warnings(warnings: &warning::Set<price::Warning>) {
123    if warnings.is_empty() {
124        return;
125    }
126
127    eprintln!(
128        "WARN: {} warnings from the linting:\n {}",
129        warnings.len_warnings(),
130        warning::SetWriter::new(warnings)
131    );
132}

Source

pub fn len_elements(&self) -> usize

Return the amount of Elements in this set.

Each Element can have many Warnings associated with it.

Source

pub fn len_warnings(&self) -> usize

Return the total amount of Warnings in this set for all Elements.

Examples found in repository ?

examples/generate_cdr_from_tariff.rs (line 80)

73fn print_warnings(warnings: &warning::Set<generate::Warning>) {
74    if warnings.is_empty() {
75        return;
76    }
77
78    eprintln!(
79        "WARN: {} warnings from the linting:\n {}",
80        warnings.len_warnings(),
81        warning::SetWriter::new(warnings)
82    );
83}

More examples

Hide additional examples

examples/price_cdr_with_known_version.rs (line 77)

70fn print_pricing_warnings(warnings: &warning::Set<price::Warning>) {
71    if warnings.is_empty() {
72        return;
73    }
74
75    eprintln!(
76        "WARN: {} warnings from the pricing:\n {}",
77        warnings.len_warnings(),
78        warning::SetWriter::new(warnings)
79    );
80}

examples/lint_tariff.rs (line 39)

32fn print_lint_warnings(warnings: &warning::Set<lint::tariff::Warning>) {
33    if warnings.is_empty() {
34        return;
35    }
36
37    eprintln!(
38        "WARN: {} warnings from the linting:\n {}",
39        warnings.len_warnings(),
40        warning::SetWriter::new(warnings)
41    );
42}

examples/price_cdr_with_unknown_version.rs (line 104)

97fn print_timezone_warnings(warnings: &warning::Set<timezone::Warning>) {
98    if warnings.is_empty() {
99        return;
100    }
101
102    eprintln!(
103        "WARN: {} warnings from the timezone search",
104        warnings.len_warnings()
105    );
106
107    eprintln!(
108        "WARN: {} warnings from the timezone search:\n {}",
109        warnings.len_warnings(),
110        warning::SetWriter::new(warnings)
111    );
112}
113
114fn print_pricing_error(error: &warning::Error<price::Warning>) {
115    eprintln!(
116        "ERR: Unable to price CDR due to error at path `{}`: {}",
117        error.element().path,
118        error.warning()
119    );
120}
121
122fn print_pricing_warnings(warnings: &warning::Set<price::Warning>) {
123    if warnings.is_empty() {
124        return;
125    }
126
127    eprintln!(
128        "WARN: {} warnings from the linting:\n {}",
129        warnings.len_warnings(),
130        warning::SetWriter::new(warnings)
131    );
132}

Source

pub fn iter(&self) -> Iter<'_, W> ⓘ

Return an iterator of Warnings grouped by json::Element.

Source

pub fn path_map(&self) -> BTreeMap<&str, &[W]>

Return a map of json::Element paths to a list of Warning.

This is designed to be used to print out maps of warnings associated with elements. You can use the debug alternate format {:#?} to print the map ‘pretty’ over multiple lines with indentation.

Source

pub fn into_path_map(self) -> BTreeMap<Path, Vec<W>>

Consume the Set and return a map of json::Element paths to a list of Warnings.

This is designed to be used to print out maps of warnings associated with elements.

Source

pub fn path_id_map(&self) -> BTreeMap<&str, Vec<Id>>

Return a map of json::Element paths to a list of Warning ids as Strings.

This is designed to be used to print out maps of warnings associated with elements. You can use the debug alternate format {:#?} to print the map ‘pretty’ over multiple lines with indentation.

Note: This representation is also valid JSON and can be copied directly to a test expectation file.

Source

pub fn path_msg_map(&self) -> BTreeMap<&str, Vec<String>>

Return a map of json::Element paths to a list of Warning messages as Strings.

This is designed to be used to print out maps of warnings associated with elements. You can use the debug alternate format {:#?} to print the map ‘pretty’ over multiple lines with indentation.