mirror of
https://github.com/Astatin3/unshell.git
synced 2026-06-08 22:38:01 -06:00
Improve protocol documentation and runtime structure
This commit is contained in:
+12
-1
@@ -1,4 +1,15 @@
|
||||
//! Canonical UnShell protocol modules.
|
||||
//! Canonical UnShell protocol surface.
|
||||
//!
|
||||
//! This module is the stable facade for wire-level protocol types, framing, and
|
||||
//! stateless validation helpers. Callers normally:
|
||||
//! - build one [`PacketHeader`] plus payload type from this module,
|
||||
//! - encode it with [`encode_packet`],
|
||||
//! - decode inbound bytes with [`decode_frame`], and
|
||||
//! - validate message/header shape with [`validate_header`], [`validate_call`], and
|
||||
//! [`validate_procedure_id`].
|
||||
//!
|
||||
//! The concrete wire structs live in the private `types` module and are re-exported here so the
|
||||
//! public API stays flat while internal archived-type details remain hidden.
|
||||
|
||||
pub mod codec;
|
||||
pub mod introspection;
|
||||
|
||||
Reference in New Issue
Block a user