lexus2k / tinyproto-rust

87%

Build Type

push

github

Committed by lexus2k

Commit Message

Add documentation, tests, examples, and fix I-frame queue bugs

Documentation:
- Add crate-level rustdoc to lib.rs describing the 3 protocol layers
- Add doc comments to all public types, functions, and methods
- cargo doc builds with zero warnings

Tests (43 → 56):
- FD protocol: disconnect, bidirectional data, multiple frames,
  data too large, send before connect
- I-queue control: retransmit, move_to_previous_ns
- Peers: multi-peer resolution, round-robin switching
- HDLC low-level: all-special-bytes payload, empty frame
- HDLC high-level: multiple frames
- Light: timeout on empty read

Examples:
- light_loopback: send/receive via simulated wire
- hdlc_encode_decode: low-level framing with CRC error detection
- fd_loopback: full connection lifecycle (SABM/UA, I-frames, DISC)

Bug fixes:
- put_i_frame used next_ns (send cursor) instead of last_ns (alloc cursor),
  causing duplicate sequence numbers when queuing multiple frames
- Confirmed I-frames were never freed from the queue (free_by_ns)
- get_next for I-frames ignored sequence number argument
- switch_to_connected now initializes retries and last_sent_i_ts

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Coverage Stats

265 of 273 new or added lines in 7 files covered. (97.07%)

157 existing lines in 7 files now uncovered.

2029 of 2340 relevant lines covered (86.71%)

6223.05 hits per line