wire-codec 1.2.0

Binary frame codec and protocol codec toolkit. Length-prefixed, varint-prefixed, delimiter-based, checksummed, and custom framing strategies. Built-in varint, zigzag, bitfield, packed struct, CRC, and COBS encoding. Allocation-free core, no_std, runtime-agnostic, with optional tokio-util and futures codec adapters.
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
38
39
40
41
42

//! Property tests for zigzag encoding.
//!
//! Invariants:
//! - `decode(encode(v)) == v` for every `i32` and `i64`.
//! - Zigzag preserves order in magnitude: `|v1| <= |v2|` implies
//!   `encode(v1) <= encode(v2)` for non-pathological cases (this is the
//!   property that makes zigzag worth pairing with varint).
//! - The mapping is a bijection: the encoded space is exactly the range of the
//!   unsigned target type.

use proptest::prelude::*;
use wire_codec::zigzag;

proptest! {
    #[test]
    fn zigzag_i32_round_trip(value in any::<i32>()) {
        prop_assert_eq!(zigzag::decode_i32(zigzag::encode_i32(value)), value);
    }

    #[test]
    fn zigzag_i64_round_trip(value in any::<i64>()) {
        prop_assert_eq!(zigzag::decode_i64(zigzag::encode_i64(value)), value);
    }

    #[test]
    fn zigzag_i32_u32_round_trip(encoded in any::<u32>()) {
        prop_assert_eq!(zigzag::encode_i32(zigzag::decode_i32(encoded)), encoded);
    }

    #[test]
    fn zigzag_i64_u64_round_trip(encoded in any::<u64>()) {
        prop_assert_eq!(zigzag::encode_i64(zigzag::decode_i64(encoded)), encoded);
    }

    #[test]
    fn zigzag_i32_small_magnitude_stays_small(value in -1_000i32..1_000) {
        // The whole point of zigzag: small-magnitude signed values produce
        // small-magnitude unsigned codes, so the varint that follows is short.
        let encoded = zigzag::encode_i32(value);
        prop_assert!(encoded < 2_001, "value={value} encoded={encoded}");
    }
}