rubo4e 0.4.0

Rust implementation of the BO4E energy-market data standard
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

# Schema Versioning

`rubo4e` exposes a single stable BO4E schema series (`v202501`), compiled
conditionally behind the `versioned` feature flag.

---

## Version Module Layout

With the `versioned` feature enabled:

```rust
rubo4e::v202501::Vertrag       // v202501 series — pinned, stable across crate updates
rubo4e::v202501::Adresse
rubo4e::v202501::Sparte

rubo4e::current::Vertrag       // moving alias — always the latest stable series
```

Without the `versioned` feature, none of these module paths exist.  The default
feature set (`serde` only) does not include versioned types.

---

## Feature Gate

```toml
# Enable version modules (no external deps; controls conditional compilation only)
rubo4e = { version = "...", features = ["versioned"] }
```

This is a **pure conditional-compilation flag**.  Enabling `versioned` makes the
compiler include the `v202501` module.  No external dependencies are added.

---

## Known Schema Series

| Series  | Pinned tag    | Status                              |
|---------|---------------|-------------------------------------|
| v202501 | v202501.0.0   | Current stable; released April 2025 |

### Versioning Scheme Explained

BO4E uses `vYYYYMM.minor.patch`.  The `MM` component is always `01` — it
represents the release cycle, not the calendar month.  Module names use the
`vYYYYMM` prefix only:

```
v202501.0.0  →  module: v202501
v202601.0.0  →  module: v202601
```

Within a series, minor/patch bumps (e.g. `v202501.0.0` → `v202501.1.0`) are
additive.  The generator pins the full semver tag for reproducibility but exposes
only the series prefix in the public API.

---

## `rubo4e::current` — Moving Alias

`rubo4e::current` is a type alias that always points to the latest stable schema
series.  Use it when you always want the newest types and do not need to pin to a
specific version.

```rust
use rubo4e::current::Vertrag;   // equivalent to rubo4e::v202501::Vertrag today
```

Pin to a concrete module (`rubo4e::v202501`) if you need version-stability across
crate updates:

```rust
use rubo4e::v202501::Vertrag;   // stable even if rubo4e::current advances
```

---

## Adding a New Schema Version

When a new BO4E schema release arrives (e.g. `v202601.0.0`) with new or changed types:

1. Download the schema snapshot:
   ```
   just download-schemas v202601.0.0
   ```
2. Run the generator targeting the new version:
   ```
   just generate v202601.0.0
   ```
3. The generator writes `src/generated/v202601/` and appends `pub mod v202601;`
   to `src/generated/mod.rs`.
4. In `src/lib.rs`, add a versioned re-export module:
   ```rust
   #[cfg(feature = "versioned")]
   pub mod v202601 {
       pub use crate::generated::v202601::*;
   }
   ```
5. Advance the `current` alias:
   ```rust
   pub use v202601 as current;  // was: v202501
   ```
6. Update the Known Schema Series table in this document.

---

## COM and Enum Versioning

COM and enum types live inside the versioned module alongside BO types.  They
follow exactly the same conditional-compilation rules.