wordval_foxglove_protocol/lib.rs
1//! wordval-foxglove-protocol:Foxglove WebSocket 协议 v1(`foxglove.websocket.v1`)
2//! 的纯编解码层,无任何 IO。
3//!
4//! 由 [`wordval-foxglove`](https://crates.io/crates/wordval-foxglove)(客户端)
5//! 与 [`wordval-ws`](https://crates.io/crates/wordval-ws)(服务端)共享,
6//! 保证两端线上格式的一致性:
7//!
8//! - [`protocol`] — JSON 控制消息与二进制帧的(反)序列化,零拷贝 `Bytes` 载荷;
9//! - [`cdr`] — CDR(ROS 2 XCDR1)载荷的 schema 驱动解码与编码(JSON ↔ CDR);
10//! - `ros2msg`(私有)— `ros2msg` schema 文本解析。
11
12#[cfg(feature = "cdr")]
13pub mod cdr;
14#[cfg(feature = "cdr")]
15mod encode;
16pub mod protocol;
17#[cfg(feature = "cdr")]
18mod ros2msg;
19
20// 未启用 `cdr` feature 时的占位实现。
21//
22// 仅提供与真实模块同名的 [`MessageDef`],保证
23// [`crate::protocol::Channel::cdr_schema`] 字段在两种 feature 状态下
24// 类型一致——依赖方(如 wordval-ws)无需按 feature 调整代码,且不会
25// 因依赖图中其他 crate 打开了 `cdr` 而产生编译分歧。
26// 真实的 schema 定义与 `parse_channel_schema` 解析入口在启用 `cdr`
27// feature 后可用。
28#[cfg(not(feature = "cdr"))]
29pub mod cdr {
30 /// 占位类型:启用 `cdr` feature 后为真实的 ros2msg 消息定义。
31 #[derive(Debug, Clone, PartialEq, Eq)]
32 pub struct MessageDef;
33}