zerodds-cdr 1.0.0-rc.3

XCDR1/XCDR2 encoder/decoder + KeyHash + PL_CDR1 helpers. Implements OMG XTypes 1.3 §7.4 wire format. Pure-Rust no_std + alloc.
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

// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 ZeroDDS Contributors
//! Crate `zerodds-cdr`. Safety classification: **SAFE**.
//!
//! XCDR1/XCDR2 encoder/decoder + KeyHash + PL_CDR1 member codec for
//! `@mutable` structured data — fully implements the OMG XTypes 1.3 §7.4
//! wire format.
//!
//! ## Spec
//!
//! - **OMG XTypes 1.3** §7.4 (Wire-Encoding) inkl. §7.4.1.2 (PL_CDR1),
//!   §7.4.2 (Plain CDR2 / Delimited CDR2 / PL_CDR2), §7.4.4 (Composite
//!   Types: String/Sequence/Array/Optional), §7.4.5 (Struct-Extensibility:
//!   final/appendable/mutable).
//! - **OMG XTypes 1.3** §7.6.8 KeyHash (CDR_BE Key-Holder + MD5-Fallback).
//! - **DDSI-RTPS 2.5** §10 Wire-Encapsulation (RepresentationIdentifier).
//!
//! ## Layer position
//!
//! Layer 1 — primitives. Direct dependents: `zerodds-types`, `zerodds-qos`,
//! `zerodds-rtps`, `zerodds-discovery`, `zerodds-dcps`, `zerodds-idl-rust`,
//! `dds-corba-{ior,iiop,giop,csiv2,cosnaming,rust}`, `zerodds-ts-wasm`.
//!
//! ## Public API (as of 1.0.0-rc.1)
//!
//! - [`BufferReader`] / [`BufferWriter`] — alignment-tracking byte-level
//!   I/O primitives.
//! - [`Endianness`] — little/big-endian marker.
//! - [`CdrEncode`] / [`CdrDecode`] — trait family for serializable
//!   types; implementations for all spec primitives plus composite
//!   types (String, `Vec<T>`, `[T; N]`, `Option<T>`) in the `composite` module.
//! - [`EncodeError`] / [`DecodeError`] — typed errors with offset
//!   information.
//! - [`fixed::Fixed`] — IDL `fixed<P,S>` decimal type with BCD encoding.
//! - [`struct_enc`] — XCDR2 extensibility encoder (`encode_final`,
//!   `encode_appendable`, [`struct_enc::MutableStructEncoder`] +
//!   `read_mutable_member`).
//! - [`xcdr1`] — XTypes-1.3-conformant PL_CDR1 member codec
//!   (`encode_pl_cdr1_member`, `read_pl_cdr1_member`,
//!   `read_all_pl_cdr1_members`, `write_pl_cdr1_sentinel`).
//! - [`key_hash::compute_key_hash`] / [`PlainCdr2BeKeyHolder`] /
//!   [`KEY_HASH_LEN`] — XTypes 1.3 §7.6.8 KeyHash with MD5 fallback.
//!
//! ## Example
//!
//! ```rust
//! use zerodds_cdr::{BufferWriter, BufferReader, Endianness, CdrEncode, CdrDecode};
//!
//! let mut w = BufferWriter::new(Endianness::Little);
//! 42u32.encode(&mut w).unwrap();
//! let bytes = w.into_bytes();
//!
//! let mut r = BufferReader::new(&bytes, Endianness::Little);
//! assert_eq!(u32::decode(&mut r).unwrap(), 42);
//! ```

#![no_std]
#![forbid(unsafe_code)]
#![warn(missing_docs)]

#[cfg(feature = "alloc")]
extern crate alloc;

#[cfg(feature = "std")]
extern crate std;

pub mod buffer;
#[cfg(feature = "alloc")]
pub mod composite;
pub mod encode;
pub mod endianness;
pub mod error;
#[cfg(feature = "alloc")]
pub mod fixed;
#[cfg(feature = "alloc")]
pub mod key_hash;
#[cfg(feature = "alloc")]
pub mod struct_enc;
#[cfg(feature = "alloc")]
pub mod type_code;
#[cfg(feature = "alloc")]
pub mod xcdr1;

#[cfg(feature = "serde-bridge")]
pub mod serde_bridge;

pub use endianness::Endianness;
pub use error::{DecodeError, EncodeError};

#[cfg(feature = "alloc")]
pub use key_hash::{KEY_HASH_LEN, PlainCdr2BeKeyHolder, compute_key_hash};

pub use buffer::BufferReader;
#[cfg(feature = "alloc")]
pub use buffer::BufferWriter;

pub use encode::{CdrDecode, CdrEncode};

#[cfg(feature = "alloc")]
pub use composite::WString;

#[cfg(feature = "alloc")]
pub use composite::{AnyValue, CorbaAny};

#[cfg(feature = "alloc")]
pub use type_code::TypeCode;