bo4e-serde

High-performance serialization for BO4E types.

Quick Start

use bo4e_serde::{to_json_german, to_json_english, from_json};
use bo4e_core::bo::Meter;

let meter = Meter {
    meter_number: Some("123".to_string()),
    ..Default::default()
};

// German output (BO4E standard)
let german_json = to_json_german(&meter)?;
// {"zaehlernummer":"123",...}

// English output
let english_json = to_json_english(&meter)?;
// {"meterNumber":"123",...}

// Deserialize (accepts both formats)
let mut bytes = german_json.into_bytes();
let parsed: Meter = from_json(&mut bytes)?;

BO4E-Rust

Rust implementation of BO4E (Business Objects for Energy) - a standardized data model for the German energy industry.

Features

• Complete BO4E Coverage: 35 Business Objects, 64 Components, 73 Enumerations
• Type-safe: Leverage Rust's type system for compile-time guarantees
• High-performance: SIMD-accelerated JSON parsing via simd-json
• Bilingual JSON: Runtime configuration for German (default) or English field names
• Compatible: Interoperable with BO4E-Python and other implementations

Installation

[dependencies]
bo4e = "0.1"

Quick Start

use bo4e::prelude::*;

// Create a meter
let meter = Meter {
    meter_number: Some("1EMH0012345678".to_string()),
    division: Some(Division::Electricity),
    meter_type: Some(MeterType::ModernMeasuringDevice),
    ..Default::default()
};

// Serialize to German JSON (BO4E standard)
let json = to_json_german(&meter).unwrap();
println!("{}", json);

// Deserialize (requires mutable slice for simd-json)
let mut bytes = json.into_bytes();
let parsed: Meter = from_json(&mut bytes).unwrap();

Bilingual JSON Support

BO4E-Rust supports both German (standard) and English field names at runtime:

use bo4e::prelude::*;

let meter = Meter {
    meter_number: Some("123".to_string()),
    ..Default::default()
};

// German field names (BO4E standard)
let german = to_json_german(&meter).unwrap();
// {"zaehlernummer":"123",...}

// English field names
let english = to_json_english(&meter).unwrap();
// {"meterNumber":"123",...}

Type Overview

Business Objects (35 types)

Components (64 types)

Address, contact, pricing, measurement, and time-related composite types including: Address, GeoCoordinates, ContactMethod, Price, Amount, PriceTier, Surcharge, MeasuredValue, Quantity, TimePeriod, MeterReading, MeterRegister, and many more.

Enumerations (73 types)

Type-safe enums for all BO4E values including: Division, EnergyDirection, MeterType, ContractStatus, CustomerType, PriceType, Unit, Currency, and more.

Crate Structure

MSRV

Minimum Supported Rust Version: 1.75

Related Projects

• BO4E-Python - Python implementation
• BO4E-Schemas - JSON schemas
• bo4e.de - Official BO4E website

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

# Build
cargo build --workspace

# Test
cargo test --workspace

# Format & lint
cargo fmt --all
cargo clippy --workspace --all-targets -- -D warnings

License

MIT License - see LICENSE