shuflr-wire 0.1.1

shuflr-wire/1 binary protocol codec — framing, parsing, xxh3 checksums
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

//! Typed errors for the wire codec.
//!
//! Decode errors fall into two classes: *framing* errors (bad magic,
//! bad xxh3, unknown kind) that indicate an incompatible / corrupt
//! peer and warrant closing the connection; *insufficient* (which is
//! not actually an Err, represented as Ok(None) by the decoder) for
//! when we simply haven't read enough bytes yet.

use thiserror::Error;

#[derive(Debug, Error)]
pub enum WireError {
    #[error("unsupported magic: got {got:?}, expected SHUFLRW1")]
    BadMagic { got: [u8; 8] },

    #[error("unsupported protocol version {got}; this codec speaks version 1")]
    BadVersion { got: u8 },

    #[error("message kind {got} is not recognized in v1")]
    UnknownKind { got: u8 },

    #[error("xxh3 mismatch on kind={kind}: wire={wire:016x}, computed={computed:016x}")]
    Xxh3Mismatch { kind: u8, wire: u64, computed: u64 },

    #[error("message payload length {got} exceeds MAX_MESSAGE_BYTES ({max})")]
    PayloadTooLarge { got: u32, max: u32 },

    #[error("truncated payload for kind={kind}: expected {expected} bytes, got {got}")]
    TruncatedPayload {
        kind: u8,
        expected: usize,
        got: usize,
    },

    #[error("malformed field in kind={kind}: {detail}")]
    Malformed { kind: u8, detail: String },
}