UNPKG

jsonbinpack

Version:

A space-efficient schema-driven binary JSON serialization format based on JSON Schema

www.jsonbinpack.org

jviotti/jsonbinpack

125 lines (86 loc) • 3.64 kB
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
Enum Encodings -------------- ### `BOUNDED_CHOICE_INDEX` The encoding consists of an index to the enumeration choices encoded as an 8-bit fixed-length unsigned integer. #### Options | Option | Type | Description | |-----------|---------|-----------------------------| | `choices` | `any[]` | The set of choice values | #### Conditions | Condition | Description | |--------------------------|--------------------------------------------------------| | `len(choices) > 0` | The choices array is not empty | | `len(choices) < 2 ** 8` | The number of choices must be representable in 8 bits | | `value in choices` | The input value is included in the set of choices | #### Examples Given an enumeration `[ 'foo', 'bar', 'baz' ]` and an input value 'bar', the encoding results in the unsigned 8 bit integer 1: ``` +------+ | 0x01 | +------+ ``` Given an enumeration `[ 'foo', 'bar', 'baz' ]` and an input value 'foo', the encoding results in the unsigned 8 bit integer 0: ``` +------+ | 0x00 | +------+ ``` ### `LARGE_BOUNDED_CHOICE_INDEX` The encoding consists of an index to the enumeration choices encoded as a Base-128 64-bit Little Endian variable-length unsigned integer. #### Options | Option | Type | Description | |-----------|---------|-----------------------------| | `choices` | `any[]` | The set of choice values | #### Conditions | Condition | Description | |--------------------------|--------------------------------------------------------| | `len(choices) > 0` | The choices array is not empty | | `value in choices` | The input value is included in the set of choices | #### Examples Given an enumeration with 1000 members and an input value that equals the 300th enumeration value, the encoding results in the Base-128 64-bit Little Endian variable-length unsigned integer 300: ``` +------+------+ | 0xac | 0x02 | +------+------+ ``` ### `TOP_LEVEL_8BIT_CHOICE_INDEX` If the input value corresponds to the index 0 to the enumeration choices, the encoding stores no data. Otherwise, the encoding consists of an index to the enumeration choices minus 1 encoded as an 8-bit fixed-length unsigned integer. #### Options | Option | Type | Description | |-----------|---------|-----------------------------| | `choices` | `any[]` | The set of choice values | #### Conditions | Condition | Description | |--------------------------|--------------------------------------------------------| | `len(choices) > 0` | The choices array is not empty | | `len(choices) < 2 ** 8` | The number of choices must be representable in 8 bits | | `value in choices` | The input value is included in the set of choices | #### Examples Given an enumeration `[ 'foo', 'bar', 'baz' ]` and an input value 'bar', the encoding results in the unsigned 8 bit integer 0: ``` +------+ | 0x00 | +------+ ``` Given an enumeration `[ 'foo', 'bar', 'baz' ]` and an input value 'foo', the value is not encoded. ### `CONST_NONE` If the enumeration choices include one element, then the input value is not encoded. #### Options | Option | Type | Description | |---------|-------|--------------------| | `value` | `any` | The constant value | #### Conditions None #### Examples The input value that matches the `value` option is not encoded.