Function parse_object 

pub fn parse_object(json: &str) -> Result<Document<'_>, ParseError>

Parse a raw JSON &str into a Document and require the root value to be a JSON object.

The input size is gated by [string::ReasonableLen]; oversized input returns ParseError::SizeExceedsMax.

Examples found in repository

examples/lint_tariff.rs (line 11)

fn main() {
    const TARIFF_JSON: &str = include_str!("data/tariff_misspelled_field.json");

    // Parse the raw JSON and validate it against the `v2.2.1` tariff schema. Any unexpected,
    // misspelled, missing, or wrongly typed fields are reported as schema warnings.
    let doc = json::parse_object(TARIFF_JSON).unwrap();
    let (tariff, warnings) = tariff::build(doc, Version::V221).into_parts();

    print_schema_warnings(&warnings);

    let report = tariff::lint(&tariff);

    print_lint_warnings(&report.warnings);
}

examples/price_cdr_with_known_version.rs (line 12)

fn main() {
    const CDR_JSON: &str = include_str!("data/cdr_time_and_parking_time.json");

    // If you know the version of a CDR you can parse it into a `json::Document` and validate it
    // against the schema for that version.
    let doc = json::parse_object(CDR_JSON).expect("unable to parse CDR");
    let (cdr, warnings) = cdr::build(doc, Version::V211).into_parts();

    if !warnings.is_empty() {
        eprintln!("The CDR has `{}` schema warnings.", warnings.len_warnings());
    }

    let report = match cdr::price(&cdr, price::TariffSource::UseCdr, Tz::Europe__Amsterdam) {
        Ok(r) => r,
        Err(set) => {
            let (error, warnings) = set.into_parts();
            print_pricing_error(&error);
            print_pricing_warnings(&warnings);
            return;
        }
    };

    let (report, warnings) = report.into_parts();
    print_pricing_warnings(&warnings);

    // The various fields of the `price::Report` can be examined or converted to JSON.
    let price::Report {
        periods: _,
        tariff_used: _,
        tariff_reports: _,
        timezone: _,
        billed_energy: _,
        billed_idle_time: _,
        total_charging_time: _,
        billed_charging_time: _,
        total_cost: _,
        total_fixed_cost: _,
        total_time: _,
        total_charging_time_cost: _,
        total_energy: _,
        total_energy_cost: _,
        total_idle_time: _,
        total_idle_cost: _,
    } = report;
}

examples/generate_cdr_from_tariff.rs (line 16)

fn main() {
    const TARIFF_JSON: &str = include_str!("data/tariff_time_and_parking_time_separate.json");

    // Parse the raw JSON into a `json::Document` and guess the OCPI version of the tariff, falling
    // back to `v2.2.1` when the version is uncertain.
    let doc = json::parse_object(TARIFF_JSON).unwrap();
    let tariff = tariff::infer_version(doc).certain_or(Version::V221);
    let tariff = tariff::build_versioned(tariff).ignore_warnings();

    let config = generate::Config {
        timezone: chrono_tz::Europe::Amsterdam,
        start_date_time: DateTime::<Utc>::from_str("2025-06-12 18:22:33+00:00").unwrap(),
        end_date_time: DateTime::<Utc>::from_str("2025-06-12 22:33:44+00:00").unwrap(),
        max_current_supply_amp: Decimal::from(4),
        requested_kwh: Decimal::from(24),
        max_power_supply_kw: Decimal::from(80),
    };
    let report = match cdr::generate_from_tariff(&tariff, &config) {
        Ok(r) => r,
        Err(set) => {
            let (error, warnings) = set.into_parts();
            print_error(&error);
            print_warnings(&warnings);
            return;
        }
    };
    let (report, warnings) = report.into_parts();

    print_warnings(&warnings);

    let generate::Report {
        tariff_id,
        tariff_currency_code,
        partial_cdr,
    } = report;

    println!("CDR generated for tariff with id: `{tariff_id}` and currency code: `{tariff_currency_code}`");
    println!("{partial_cdr:#?}");
}

examples/price_cdr_with_unknown_version.rs (line 12)

fn main() {
    const CDR_JSON: &str = include_str!("data/cdr_time_and_parking_time.json");

    // First the raw JSON is parsed into a `json::Document` and the OCPI version of the CDR is
    // guessed. The `guess::CdrVersion` returned from calling `cdr::infer_version` is either certain
    // or uncertain about the version of the contained `cdr::Versioned` object.
    let cdr = json::parse_object(CDR_JSON).expect("Unable to parse CDR JSON");
    let cdr = cdr::infer_version(cdr);

    // The guessed Version can be either certain or uncertain.
    // If the version is uncertain then fallback to presuming the CDR is v211.
    let cdr = cdr.certain_or(Version::V211);
    let cdr = cdr::build_versioned(cdr).ignore_warnings();

    // The timezone can be inferred or found in the CDR, but a versioned CDR is required.
    let timezone = match timezone::find_or_infer(&cdr) {
        Ok(tz) => tz,
        Err(err_set) => {
            let (error, warnings) = err_set.into_parts();
            eprintln!("Unable to infer timezone");
            print_timezone_error(&error);
            print_timezone_warnings(&warnings);
            return;
        }
    };
    let (timezone_source, warnings) = timezone.into_parts();

    if !warnings.is_empty() {
        print_timezone_warnings(&warnings);
    }

    // We don't care whether the timezone was found or inferred.
    let timezone = timezone_source.into_timezone();

    let report = match cdr::price(&cdr, price::TariffSource::UseCdr, timezone) {
        Ok(r) => r,
        Err(set) => {
            let (error, warnings) = set.into_parts();
            print_pricing_error(&error);
            print_pricing_warnings(&warnings);
            return;
        }
    };

    let (report, warnings) = report.into_parts();

    print_pricing_warnings(&warnings);

    // The various fields of the `price::Report` can be examined or converted to JSON.
    let price::Report {
        periods: _,
        tariff_used: _,
        tariff_reports: _,
        timezone: _,
        billed_energy: _,
        billed_idle_time: _,
        total_charging_time: _,
        billed_charging_time: _,
        total_cost: _,
        total_fixed_cost: _,
        total_time: _,
        total_charging_time_cost: _,
        total_energy: _,
        total_energy_cost: _,
        total_idle_time: _,
        total_idle_cost: _,
    } = report;
}