commy-wire 0.2.3

Commy wire contract (spec, JSON Schema, golden vectors, shared Rust wire types).
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

{
  "_comment": "Golden vectors for the binary range frame. See spec/range-frame.md. Integers are little-endian. Generated once; edit by hand only with a spec change. Entries with header_hex and payload_repeat stand for header bytes followed by `count` copies of `byte` (keeps the file small).",
  "valid": [
    {
      "name": "three bytes at page offset",
      "hex": "01010000000200000000000000001000000000000003000000deadbe",
      "file_id": 1,
      "seq": 2,
      "offset": 4096,
      "data_hex": "deadbe"
    },
    {
      "name": "single byte at offset zero",
      "hex": "01000000000000000000000000000000000000000001000000ff",
      "file_id": 0,
      "seq": 0,
      "offset": 0,
      "data_hex": "ff"
    },
    {
      "name": "large ids and offset",
      "hex": "01ffffffff0100000000000000ffffffff0f000000020000000102",
      "file_id": 4294967295,
      "seq": 1,
      "offset": 68719476735,
      "data_hex": "0102"
    },
    {
      "name": "payload exactly at the 1 MiB maximum",
      "header_hex": "01010000000200000000000000000000000000000000001000",
      "payload_repeat": {
        "byte": "ab",
        "count": 1048576
      },
      "file_id": 1,
      "seq": 2,
      "offset": 0
    }
  ],
  "invalid": [
    {
      "name": "empty input",
      "hex": "",
      "error": "Truncated"
    },
    {
      "name": "shorter than header",
      "hex": "010100000002000000000000000010000000000000030000",
      "error": "Truncated"
    },
    {
      "name": "unknown kind byte",
      "hex": "02010000000200000000000000001000000000000003000000deadbe",
      "error": "BadKind"
    },
    {
      "name": "len says 4 but 3 bytes follow",
      "hex": "01010000000200000000000000001000000000000004000000deadbe",
      "error": "LengthMismatch"
    },
    {
      "name": "len says 3 but 4 bytes follow",
      "hex": "01010000000200000000000000001000000000000003000000deadbeef",
      "error": "LengthMismatch"
    },
    {
      "name": "zero-length range",
      "hex": "01010000000200000000000000001000000000000000000000",
      "error": "EmptyRange"
    },
    {
      "name": "offset plus len overflows u64",
      "hex": "01010000000200000000000000ffffffffffffffff03000000deadbe",
      "error": "OffsetOverflow"
    },
    {
      "name": "payload over the 1 MiB maximum",
      "header_hex": "01010000000200000000000000000000000000000001001000",
      "payload_repeat": {
        "byte": "00",
        "count": 1048577
      },
      "error": "TooLarge"
    }
  ]
}