Skip to main content

Module header

Module header 

Source
Expand description

Peat-Lite packet header codec.

The header is a fixed 16-byte prefix on every packet:

┌──────────┬─────────┬──────────┬──────────┬──────────┬──────────────┐
│  MAGIC   │ Version │   Type   │  Flags   │  NodeID  │   SeqNum     │
│  4 bytes │ 1 byte  │  1 byte  │  2 bytes │  4 bytes │   4 bytes    │
└──────────┴─────────┴──────────┴──────────┴──────────┴──────────────┘

Structs§

Header
Decoded header fields.

Functions§

decode_header
Decode a header from buf, returning the header and a slice of the remaining payload bytes.
encode_header
Encode a header into the first 16 bytes of buf.