ndn_faces/serial/mod.rs
1//! # `ndn_faces::serial` — Serial port faces
2//!
3//! NDN face transport over serial (UART) links, suitable for embedded and IoT
4//! deployments. Uses COBS (Consistent Overhead Byte Stuffing) framing to
5//! delimit NDN packets on a byte stream.
6//!
7//! ## Key types
8//!
9//! - [`SerialFace`] — a `StreamFace` alias for serial port transport
10//! - [`serial_face_open()`] — opens a serial port as an NDN face (requires the `serial` feature)
11//! - [`cobs::CobsCodec`] — COBS framing codec
12
13#![allow(missing_docs)]
14
15pub mod cobs;
16#[allow(clippy::module_inception)]
17pub mod serial;
18
19pub use serial::SerialFace;
20#[cfg(feature = "serial")]
21pub use serial::serial_face_open;