Trait Bo4eEnum

Source

pub trait Bo4eEnum:
    Sealed
    + Copy
    + Sized
    + 'static {
    const VARIANTS: &'static [Self];
    const COUNT: usize;

    // Required methods
    fn as_wire(&self) -> &'static str;
    fn from_wire(s: &str) -> Result<Self, UnknownVariant>;
    fn is_unknown(&self) -> bool;

    // Provided method
    fn is_known(&self) -> bool { ... }
}

Available on crate feature versioned only.

Expand description

Uniform introspection & strict-parsing surface implemented by every generated BO4E enum (Zaehlertyp, Marktrolle, BdewArtikelnummer, …).

Every BO4E enum carries an Unknown catch-all, so the serde / FromStr path never fails on an unrecognized wire value — right for forward compatibility, wrong at an ingest boundary. These members close that gap without the strum feature.

They are inherent methods too, so importing the trait matters only for code generic over the enum type.

§Example

use rubo4e::{current::Zaehlertyp, Bo4eEnum};

// Introspection without `strum`:
assert_eq!(Zaehlertyp::COUNT, Zaehlertyp::VARIANTS.len());

// Strict parsing at the ingest boundary:
assert_eq!(Zaehlertyp::from_wire("WASSERZAEHLER"), Ok(Zaehlertyp::Wasserzaehler));
assert!(Zaehlertyp::from_wire("NOT_A_REAL_VALUE").is_err());

// Detect lenient-decode fall-through:
let z: Zaehlertyp = serde_json::from_str("\"BOGUS\"").unwrap();
assert!(z.is_unknown());

§Derived traits on every BO4E enum

Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash.

Ord is declaration order, not a business ranking — schema order, with Unknown last. Total, so BTreeMap and sort() work, but a schema release may reorder the values: never persist a sort key derived from it. Compare as_wire where the order must be stable.

§Sealed trait

Bo4eEnum is sealed — it cannot be implemented outside this crate.

Required Associated Constants§

Source

const VARIANTS: &'static [Self]

All variants defined by the BO4E schema, in declaration order.

Excludes the synthetic Unknown catch-all, so this is exactly the set of values that appear on the wire.

Source

const COUNT: usize

Number of schema-defined variants (equal to VARIANTS.len()), excluding the Unknown catch-all. Stable for a given schema version — use it to drift-guard hand-maintained variant counts.

Required Methods§

Source

fn as_wire(&self) -> &'static str

Returns the canonical BO4E wire string (SCREAMING_SNAKE_CASE) for this value.

Source

fn from_wire(s: &str) -> Result<Self, UnknownVariant>

Strictly parses a BO4E wire string, returning Err for any value not defined in this schema version — including the literal "UNKNOWN".

This is the opt-in strict counterpart to the lenient serde / FromStr path, which maps unrecognized values to the Unknown catch-all.

Source

fn is_unknown(&self) -> bool

Returns true if this value is the forward-compatibility Unknown catch-all — i.e. an out-of-schema value produced by a lenient decode.

Provided Methods§

Source

fn is_known(&self) -> bool

Returns true if this value is a known, schema-defined variant.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Trait Bo4eEnum Copy item path

§Example

§Derived traits on every BO4E enum

§Sealed trait

Required Associated Constants§

const VARIANTS: &'static [Self]

const COUNT: usize

Required Methods§

fn as_wire(&self) -> &'static str

fn from_wire(s: &str) -> Result<Self, UnknownVariant>

fn is_unknown(&self) -> bool

Provided Methods§

fn is_known(&self) -> bool

Dyn Compatibility§

Implementors§

impl Bo4eEnum for AbgabeArt

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for Abwicklungsmodell

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for Aggregationsverantwortung

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for Angebotsstatus

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for Anrede

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for AufAbschlagstyp

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for AufAbschlagsziel

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for Ausschreibungsportal

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for Ausschreibungsstatus

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for Ausschreibungstyp

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for BdewArtikelnummer

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for Befestigungsart

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for Bemessungsgroesse

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for Bilanzierungsmethode

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for BoTyp

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for ComTyp

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for Dienstleistungstyp

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for EMobilitaetsart

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for Energierichtung

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for Erzeugungsart

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for Fallgruppenzuordnung

const VARIANTS: &'static [Self] = Self::VARIANTS

const COUNT: usize = Self::COUNT

impl Bo4eEnum for Gasqualitaet

const VARIANTS: &'static [Self] = Self::VARIANTS

Trait Bo4eEnum