deku_string 0.4.1

Encoding/decoding helpers for Deku, String, Vec in fixed, Pascal, .NET and C-style formats with length guarantee.
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
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
use super::layouts::FIXED_LENGTH;

/// Raw data size
const UTF_8_FIXED_LENGTH_DATA: usize = FIXED_LENGTH;
/// Raw data size
const UTF_16_FIXED_LENGTH_DATA: usize = FIXED_LENGTH * 2;
const UTF_32_FIXED_LENGTH_DATA: usize = FIXED_LENGTH * 4;

// -------------------------------------------------
// ---------- UTF encoding is invalid --------------
// -------------------------------------------------
//
// Error: parse

// ---------- UTF encoding is invalid (UTF-8 little)
pub(crate) const UTF_8_FIXED_FORCE_ZERO_LITTLE_INVALID_UTF:
    &[u8; UTF_8_FIXED_LENGTH_DATA] = b" \xe2\x28\xa1\x00";
pub(crate) const UTF_8_FIXED_ALLOW_NO_ZERO_LITTLE_INVALID_UTF:
    &[u8; UTF_8_FIXED_LENGTH_DATA] = b" \xe2\x28\xa1\x00";
pub(crate) const UTF_8_PREFIX_U8_LITTLE_INVALID_UTF: &[u8; 8] = b"\x07utf-\xe2\x28\xa1";
pub(crate) const UTF_8_PREFIX_U16_LITTLE_INVALID_UTF: &[u8; 9] =
    b"\x07\x00utf-\xe2\x28\xa1";
pub(crate) const UTF_8_PREFIX_U32_LITTLE_INVALID_UTF: &[u8; 11] =
    b"\x07\x00\x00\x00utf-\xe2\x28\xa1";
pub(crate) const UTF_8_PREFIX_U32_7BIT_LITTLE_INVALID_UTF: &[u8; 8] =
    b"\x07utf-\xe2\x28\xa1";
pub(crate) const UTF_8_ZERO_ENDED_LITTLE_INVALID_UTF: &[u8; UTF_8_FIXED_LENGTH_DATA] =
    b" \xe2\x28\xa1\x00";

// ---------- UTF encoding is invalid (UTF-16 little)
pub(crate) const UTF_16_FIXED_FORCE_ZERO_LITTLE_INVALID_UTF:
    &[u8; UTF_16_FIXED_LENGTH_DATA] = b" \x00\xdc\xdc\xdc\xdc\xdc\xdc\x00\x00";
pub(crate) const UTF_16_FIXED_ALLOW_NO_ZERO_LITTLE_INVALID_UTF:
    &[u8; UTF_16_FIXED_LENGTH_DATA] = b" \x00\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc";
pub(crate) const UTF_16_PREFIX_U8_LITTLE_INVALID_UTF: &[u8; 3] = b"\x01\xdc\xdc";
pub(crate) const UTF_16_PREFIX_U16_LITTLE_INVALID_UTF: &[u8; 4] = b"\x01\x00\xdc\xdc";
pub(crate) const UTF_16_PREFIX_U32_LITTLE_INVALID_UTF: &[u8; 6] =
    b"\x01\x00\x00\x00\xdc\xdc";
pub(crate) const UTF_16_PREFIX_U32_7BIT_LITTLE_INVALID_UTF: &[u8; 3] = b"\x01\xdc\xdc";
pub(crate) const UTF_16_ZERO_ENDED_LITTLE_INVALID_UTF: &[u8; UTF_16_FIXED_LENGTH_DATA] =
    b"\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\x00\x00";

// ---------- UTF encoding is invalid (UTF-32 little)
pub(crate) const UTF_32_FIXED_FORCE_ZERO_LITTLE_INVALID_UTF:
    &[u8; UTF_32_FIXED_LENGTH_DATA] =
    b" \x00\x00\x00\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\x00\x00\x00\x00";
pub(crate) const UTF_32_FIXED_ALLOW_NO_ZERO_LITTLE_INVALID_UTF:
    &[u8; UTF_32_FIXED_LENGTH_DATA] =
    b" \x00\x00\x00\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc";
pub(crate) const UTF_32_PREFIX_U8_LITTLE_INVALID_UTF: &[u8; 5] =
    b"\x01\xdc\xdc\xdc\xdc";
pub(crate) const UTF_32_PREFIX_U16_LITTLE_INVALID_UTF: &[u8; 6] =
    b"\x01\x00\xdc\xdc\xdc\xdc";
pub(crate) const UTF_32_PREFIX_U32_LITTLE_INVALID_UTF: &[u8; 8] =
    b"\x01\x00\x00\x00\xdc\xdc\xdc\xdc";
pub(crate) const UTF_32_PREFIX_U32_7BIT_LITTLE_INVALID_UTF: &[u8; 5] =
    b"\x01\xdc\xdc\xdc\xdc";
pub(crate) const UTF_32_ZERO_ENDED_LITTLE_INVALID_UTF: &[u8; UTF_32_FIXED_LENGTH_DATA] =
    b"\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\x00\x00\x00\x00\x00";

// ---------- UTF encoding is invalid (UTF-8 big)
pub(crate) const UTF_8_FIXED_FORCE_ZERO_BIG_INVALID_UTF: &[u8;
     UTF_8_FIXED_LENGTH_DATA] = b" \xe2\x28\xa1\x00";
pub(crate) const UTF_8_FIXED_ALLOW_NO_ZERO_BIG_INVALID_UTF:
    &[u8; UTF_8_FIXED_LENGTH_DATA] = b" \xe2\x28\xa1\x00";
pub(crate) const UTF_8_PREFIX_U8_BIG_INVALID_UTF: &[u8; 8] = b"\x07utf-\xe2\x28\xa1";
pub(crate) const UTF_8_PREFIX_U16_BIG_INVALID_UTF: &[u8; 9] =
    b"\x00\x07utf-\xe2\x28\xa1";
pub(crate) const UTF_8_PREFIX_U32_BIG_INVALID_UTF: &[u8; 11] =
    b"\x00\x00\x00\x07utf-\xe2\x28\xa1";
pub(crate) const UTF_8_PREFIX_U32_7BIT_BIG_INVALID_UTF: &[u8; 8] =
    b"\x07utf-\xe2\x28\xa1";
pub(crate) const UTF_8_ZERO_ENDED_BIG_INVALID_UTF: &[u8; UTF_8_FIXED_LENGTH_DATA] =
    b" \xe2\x28\xa1\x00";

// ---------- UTF encoding is invalid (UTF-16 big)
pub(crate) const UTF_16_FIXED_FORCE_ZERO_BIG_INVALID_UTF:
    &[u8; UTF_16_FIXED_LENGTH_DATA] = b"\x00 \xdc\xdc\xdc\xdc\xdc\xdc\x00\x00";
pub(crate) const UTF_16_FIXED_ALLOW_NO_ZERO_BIG_INVALID_UTF:
    &[u8; UTF_16_FIXED_LENGTH_DATA] = b"\x00 \xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc";
pub(crate) const UTF_16_PREFIX_U8_BIG_INVALID_UTF: &[u8; 3] = b"\x01\xdc\xdc";
pub(crate) const UTF_16_PREFIX_U16_BIG_INVALID_UTF: &[u8; 4] = b"\x00\x01\xdc\xdc";
pub(crate) const UTF_16_PREFIX_U32_BIG_INVALID_UTF: &[u8; 6] =
    b"\x00\x00\x00\x01\xdc\xdc";
pub(crate) const UTF_16_PREFIX_U32_7BIT_BIG_INVALID_UTF: &[u8; 3] = b"\x01\xdc\xdc";
pub(crate) const UTF_16_ZERO_ENDED_BIG_INVALID_UTF: &[u8; UTF_16_FIXED_LENGTH_DATA] =
    b"\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\x00\x00";

// ---------- UTF encoding is invalid (UTF-32 big)
pub(crate) const UTF_32_FIXED_FORCE_ZERO_BIG_INVALID_UTF:
    &[u8; UTF_32_FIXED_LENGTH_DATA] =
    b"\x00\x00\x00 \xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\x00\x00\x00\x00";
pub(crate) const UTF_32_FIXED_ALLOW_NO_ZERO_BIG_INVALID_UTF:
    &[u8; UTF_32_FIXED_LENGTH_DATA] =
    b"\x00\x00\x00 \xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc";
pub(crate) const UTF_32_PREFIX_U8_BIG_INVALID_UTF: &[u8; 5] = b"\x01\xdc\xdc\xdc\xdc";
pub(crate) const UTF_32_PREFIX_U16_BIG_INVALID_UTF: &[u8; 6] =
    b"\x00\x01\xdc\xdc\xdc\xdc";
pub(crate) const UTF_32_PREFIX_U32_BIG_INVALID_UTF: &[u8; 8] =
    b"\x00\x00\x00\x01\xdc\xdc\xdc\xdc";
pub(crate) const UTF_32_PREFIX_U32_7BIT_BIG_INVALID_UTF: &[u8; 5] =
    b"\x01\xdc\xdc\xdc\xdc";
pub(crate) const UTF_32_ZERO_ENDED_BIG_INVALID_UTF: &[u8; UTF_32_FIXED_LENGTH_DATA] =
    b"\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\xdc\x00\x00\x00\x00\x00";

// -------------%<-------------%<------|------->%------------->%-------------

// -------------------------------------------------
// ---------- No null while expected --------------
// -------------------------------------------------
//
// Error: assertion
//
// * `StringLayout::FixedLength(allow_no_null = true)` — is accepted
// * `StringLayout::LengthPrefix` — is accepted

// ---------- No null while expected (UTF-8 little)
pub(crate) const UTF_8_FIXED_FORCE_ZERO_LITTLE_NO_NULL_INSIDE:
    &[u8; UTF_8_FIXED_LENGTH_DATA] = b"zero?";
pub(crate) const UTF_8_ZERO_ENDED_LITTLE_NO_NULL_INSIDE: &[u8;
     UTF_8_FIXED_LENGTH_DATA] = b"zero?";

// ---------- No null while expected (UTF-16 little)
pub(crate) const UTF_16_FIXED_FORCE_ZERO_LITTLE_NO_NULL_INSIDE:
    &[u8; UTF_16_FIXED_LENGTH_DATA] = b"z\x00e\x00r\x00o\x00?\x00";
pub(crate) const UTF_16_ZERO_ENDED_LITTLE_NO_NULL_INSIDE: &[u8; 10] =
    b"z\x00e\x00r\x00o\x00?\x00";

// ---------- No null while expected (UTF-32 little)
pub(crate) const UTF_32_FIXED_FORCE_ZERO_LITTLE_NO_NULL_INSIDE:
    &[u8; UTF_32_FIXED_LENGTH_DATA] =
    b"z\x00\x00\x00e\x00\x00\x00r\x00\x00\x00o\x00\x00\x00?\x00\x00\x00";
pub(crate) const UTF_32_ZERO_ENDED_LITTLE_NO_NULL_INSIDE:
    &[u8; UTF_32_FIXED_LENGTH_DATA] =
    b"z\x00\x00\x00e\x00\x00\x00r\x00\x00\x00o\x00\x00\x00?\x00\x00\x00";

// ---------- No null while expected (UTF-8 big)
pub(crate) const UTF_8_FIXED_FORCE_ZERO_BIG_NO_NULL_INSIDE:
    &[u8; UTF_8_FIXED_LENGTH_DATA] = b"zero?";
pub(crate) const UTF_8_ZERO_ENDED_BIG_NO_NULL_INSIDE: &[u8; UTF_8_FIXED_LENGTH_DATA] =
    b"zero?";

// ---------- No null while expected (UTF-16 big)
pub(crate) const UTF_16_FIXED_FORCE_ZERO_BIG_NO_NULL_INSIDE:
    &[u8; UTF_16_FIXED_LENGTH_DATA] = b"\x00z\x00e\x00r\x00o\x00?";
pub(crate) const UTF_16_ZERO_ENDED_BIG_NO_NULL_INSIDE: &[u8; 10] =
    b"\x00z\x00e\x00r\x00o\x00?";

// ---------- No null while expected (UTF-32 big)
pub(crate) const UTF_32_FIXED_FORCE_ZERO_BIG_NO_NULL_INSIDE:
    &[u8; UTF_32_FIXED_LENGTH_DATA] =
    b"\x00\x00\x00z\x00\x00\x00e\x00\x00\x00r\x00\x00\x00o\x00\x00\x00?";
pub(crate) const UTF_32_ZERO_ENDED_BIG_NO_NULL_INSIDE: &[u8; UTF_32_FIXED_LENGTH_DATA] =
    b"\x00\x00\x00z\x00\x00\x00e\x00\x00\x00r\x00\x00\x00o\x00\x00\x00?";

// -------------%<-------------%<------|------->%------------->%-------------

// --------------------------------------------
// ---------- Zero in the middle --------------
// --------------------------------------------
//
// Error: assertion
//
// * `StringLayout::FixedLength` — is accepted
// * `StringLayout::ZeroEnded` — is end of data

// ---------- Zero in the middle (UTF-8 little)
pub(crate) const UTF_8_PREFIX_U8_LITTLE_ZERO_IN_MIDDLE: &[u8; 3] = b"\x02\x00a";
pub(crate) const UTF_8_PREFIX_U16_LITTLE_ZERO_IN_MIDDLE: &[u8; 4] = b"\x02\x00\x00a";
pub(crate) const UTF_8_PREFIX_U32_LITTLE_ZERO_IN_MIDDLE: &[u8; 6] =
    b"\x02\x00\x00\x00\x00a";
pub(crate) const UTF_8_PREFIX_U32_7BIT_LITTLE_ZERO_IN_MIDDLE: &[u8; 3] = b"\x02\x00a";

// ---------- Zero in the middle (UTF-16 little)
pub(crate) const UTF_16_PREFIX_U8_LITTLE_ZERO_IN_MIDDLE: &[u8; 5] =
    b"\x02\x00\x00a\x00";
pub(crate) const UTF_16_PREFIX_U16_LITTLE_ZERO_IN_MIDDLE: &[u8; 6] =
    b"\x02\x00\x00\x00a\x00";
pub(crate) const UTF_16_PREFIX_U32_LITTLE_ZERO_IN_MIDDLE: &[u8; 8] =
    b"\x02\x00\x00\x00\x00\x00a\x00";
pub(crate) const UTF_16_PREFIX_U32_7BIT_LITTLE_ZERO_IN_MIDDLE: &[u8; 5] =
    b"\x02\x00\x00a\x00";

// ---------- Zero in the middle (UTF-32 little)
pub(crate) const UTF_32_PREFIX_U8_LITTLE_ZERO_IN_MIDDLE: &[u8; 9] =
    b"\x02\x00\x00\x00a\x00\x00\x00\x00";
pub(crate) const UTF_32_PREFIX_U16_LITTLE_ZERO_IN_MIDDLE: &[u8; 11] =
    b"\x02\x00\x00\x00\x00\x00\x00a\x00\x00\x00";
pub(crate) const UTF_32_PREFIX_U32_LITTLE_ZERO_IN_MIDDLE: &[u8; 12] =
    b"\x02\x00\x00\x00a\x00\x00\x00\x00\x00\x00\x00";
pub(crate) const UTF_32_PREFIX_U32_7BIT_LITTLE_ZERO_IN_MIDDLE: &[u8; 9] =
    b"\x02a\x00\x00\x00\x00\x00\x00\x00";

// ---------- Zero in the middle (UTF-8 big)
pub(crate) const UTF_8_PREFIX_U8_BIG_ZERO_IN_MIDDLE: &[u8; 3] = b"\x02\x00a";
pub(crate) const UTF_8_PREFIX_U16_BIG_ZERO_IN_MIDDLE: &[u8; 4] = b"\x00\x02\x00a";
pub(crate) const UTF_8_PREFIX_U32_BIG_ZERO_IN_MIDDLE: &[u8; 6] =
    b"\x00\x00\x00\x02\x00a";
pub(crate) const UTF_8_PREFIX_U32_7BIT_BIG_ZERO_IN_MIDDLE: &[u8; 3] = b"\x02\x00a";

// ---------- Zero in the middle (UTF-16 big)
pub(crate) const UTF_16_PREFIX_U8_BIG_ZERO_IN_MIDDLE: &[u8; 5] = b"\x02\x00\x00\x00a";
pub(crate) const UTF_16_PREFIX_U16_BIG_ZERO_IN_MIDDLE: &[u8; 6] =
    b"\x00\x02\x00\x00\x00a";
pub(crate) const UTF_16_PREFIX_U32_BIG_ZERO_IN_MIDDLE: &[u8; 8] =
    b"\x00\x00\x00\x02\x00\x00\x00a";
pub(crate) const UTF_16_PREFIX_U32_7BIT_BIG_ZERO_IN_MIDDLE: &[u8; 5] =
    b"\x02\x00\x00\x00a";

// ---------- Zero in the middle (UTF-32 big)
pub(crate) const UTF_32_PREFIX_U8_BIG_ZERO_IN_MIDDLE: &[u8; 9] =
    b"\x02\x00\x00\x00\x00\x00\x00\x00a";
pub(crate) const UTF_32_PREFIX_U16_BIG_ZERO_IN_MIDDLE: &[u8; 10] =
    b"\x00\x02\x00\x00\x00a\x00\x00\x00\x00";
pub(crate) const UTF_32_PREFIX_U32_BIG_ZERO_IN_MIDDLE: &[u8; 12] =
    b"\x00\x00\x00\x02\x00\x00\x00a\x00\x00\x00\x00";
pub(crate) const UTF_32_PREFIX_U32_7BIT_BIG_ZERO_IN_MIDDLE: &[u8; 9] =
    b"\x02\x00\x00\x00a\x00\x00\x00\x00";

// -------------%<-------------%<------|------->%------------->%-------------

// --------------------------------------------
// ---------- Short length, no data -----------
// --------------------------------------------
//
// Error: incomplete
//
// * `StringLayout::FixedLength` — length is specified in format
// * `StringLayout::ZeroEnded` — length is dynamic

// ---------- Short length, no data (UTF-8 little)
pub(crate) const UTF_8_PREFIX_U8_LITTLE_SHORT_LEN: &[u8; 1] = b"\x01";
pub(crate) const UTF_8_PREFIX_U16_LITTLE_SHORT_LEN: &[u8; 2] = b"\x01\x00";
pub(crate) const UTF_8_PREFIX_U32_LITTLE_SHORT_LEN: &[u8; 4] = b"\x01\x00\x00\x00";
pub(crate) const UTF_8_PREFIX_U32_7BIT_LITTLE_SHORT_LEN: &[u8; 1] = b"\x01";

// ---------- Short length, no data (UTF-16 little)
pub(crate) const UTF_16_PREFIX_U8_LITTLE_SHORT_LEN: &[u8; 1] = b"\x01";
pub(crate) const UTF_16_PREFIX_U16_LITTLE_SHORT_LEN: &[u8; 2] = b"\x01\x00";
pub(crate) const UTF_16_PREFIX_U32_LITTLE_SHORT_LEN: &[u8; 4] = b"\x01\x00\x00\x00";
pub(crate) const UTF_16_PREFIX_U32_7BIT_LITTLE_SHORT_LEN: &[u8; 1] = b"\x01";

// ---------- Short length, no data (UTF-32 little)
pub(crate) const UTF_32_PREFIX_U8_LITTLE_SHORT_LEN: &[u8; 1] = b"\x01";
pub(crate) const UTF_32_PREFIX_U16_LITTLE_SHORT_LEN: &[u8; 2] = b"\x01\x00";
pub(crate) const UTF_32_PREFIX_U32_LITTLE_SHORT_LEN: &[u8; 4] = b"\x01\x00\x00\x00";
pub(crate) const UTF_32_PREFIX_U32_7BIT_LITTLE_SHORT_LEN: &[u8; 1] = b"\x01";

// ---------- Short length, no data (UTF-8 big)
pub(crate) const UTF_8_PREFIX_U8_BIG_SHORT_LEN: &[u8; 1] = b"\x01";
pub(crate) const UTF_8_PREFIX_U16_BIG_SHORT_LEN: &[u8; 2] = b"\x01\x00";
pub(crate) const UTF_8_PREFIX_U32_BIG_SHORT_LEN: &[u8; 4] = b"\x01\x00\x00\x00";
pub(crate) const UTF_8_PREFIX_U32_7BIT_BIG_SHORT_LEN: &[u8; 1] = b"\x01";

// ---------- Short length, no data (UTF-16 big)
pub(crate) const UTF_16_PREFIX_U8_BIG_SHORT_LEN: &[u8; 1] = b"\x01";
pub(crate) const UTF_16_PREFIX_U16_BIG_SHORT_LEN: &[u8; 2] = b"\x00\x01";
pub(crate) const UTF_16_PREFIX_U32_BIG_SHORT_LEN: &[u8; 4] = b"\x01\x00\x00\x00";
pub(crate) const UTF_16_PREFIX_U32_7BIT_BIG_SHORT_LEN: &[u8; 1] = b"\x01";

// ---------- Short length, no data (UTF-32 big)
pub(crate) const UTF_32_PREFIX_U8_BIG_SHORT_LEN: &[u8; 1] = b"\x01";
pub(crate) const UTF_32_PREFIX_U16_BIG_SHORT_LEN: &[u8; 2] = b"\x00\x01";
pub(crate) const UTF_32_PREFIX_U32_BIG_SHORT_LEN: &[u8; 4] = b"\x01\x00\x00\x00";
pub(crate) const UTF_32_PREFIX_U32_7BIT_BIG_SHORT_LEN: &[u8; 1] = b"\x01";

// -------------%<-------------%<------|------->%------------->%-------------

// ----------------------------------------------
// ---------- Good length, short data -----------
// ----------------------------------------------
//
// Error: incomplete
//
// * `StringLayout::FixedLength` — length is specified in format
// * `StringLayout::ZeroEnded` — length is dynamic

// ---------- Short length, no data (UTF-8 little)
pub(crate) const UTF_8_PREFIX_U8_LITTLE_SHORT_DATA: &[u8; 2] = b"\x02a";
pub(crate) const UTF_8_PREFIX_U16_LITTLE_SHORT_DATA: &[u8; 3] = b"\x02\x00a";
pub(crate) const UTF_8_PREFIX_U32_LITTLE_SHORT_DATA: &[u8; 5] = b"\x02\x00\x00\x00a";
pub(crate) const UTF_8_PREFIX_U32_7BIT_LITTLE_SHORT_DATA: &[u8; 2] = b"\x02a";

// ---------- Short length, no data (UTF-16 little)
pub(crate) const UTF_16_PREFIX_U8_LITTLE_SHORT_DATA: &[u8; 3] = b"\x02a\x00";
pub(crate) const UTF_16_PREFIX_U16_LITTLE_SHORT_DATA: &[u8; 4] = b"\x02\x00a\x00";
pub(crate) const UTF_16_PREFIX_U32_LITTLE_SHORT_DATA: &[u8; 6] =
    b"\x02\x00\x00\x00a\x00";
pub(crate) const UTF_16_PREFIX_U32_7BIT_LITTLE_SHORT_DATA: &[u8; 3] = b"\x02a\x00";

// ---------- Short length, no data (UTF-32 little)
pub(crate) const UTF_32_PREFIX_U8_LITTLE_SHORT_DATA: &[u8; 5] = b"\x02a\x00\x00\x00";
pub(crate) const UTF_32_PREFIX_U16_LITTLE_SHORT_DATA: &[u8; 6] =
    b"\x02\x00a\x00\x00\x00";
pub(crate) const UTF_32_PREFIX_U32_LITTLE_SHORT_DATA: &[u8; 8] =
    b"\x02\x00\x00\x00a\x00\x00\x00";
pub(crate) const UTF_32_PREFIX_U32_7BIT_LITTLE_SHORT_DATA: &[u8; 5] =
    b"\x02a\x00\x00\x00";

// ---------- Short length, no data (UTF-8 big)
pub(crate) const UTF_8_PREFIX_U8_BIG_SHORT_DATA: &[u8; 2] = b"\x02a";
pub(crate) const UTF_8_PREFIX_U16_BIG_SHORT_DATA: &[u8; 3] = b"\x02\x00a";
pub(crate) const UTF_8_PREFIX_U32_BIG_SHORT_DATA: &[u8; 5] = b"\x02\x00\x00\x00a";
pub(crate) const UTF_8_PREFIX_U32_7BIT_BIG_SHORT_DATA: &[u8; 2] = b"\x02a";

// ---------- Short length, no data (UTF-16 big)
pub(crate) const UTF_16_PREFIX_U8_BIG_SHORT_DATA: &[u8; 3] = b"\x02\x00a";
pub(crate) const UTF_16_PREFIX_U16_BIG_SHORT_DATA: &[u8; 4] = b"\x00\x02\x00a";
pub(crate) const UTF_16_PREFIX_U32_BIG_SHORT_DATA: &[u8; 6] = b"\x00\x00\x00\x02\x00a";
pub(crate) const UTF_16_PREFIX_U32_7BIT_BIG_SHORT_DATA: &[u8; 3] = b"\x02\x00a";

// ---------- Short length, no data (UTF-32 big)
pub(crate) const UTF_32_PREFIX_U8_BIG_SHORT_DATA: &[u8; 5] = b"\x02\x00\x00\x00a";
pub(crate) const UTF_32_PREFIX_U16_BIG_SHORT_DATA: &[u8; 6] = b"\x00\x02\x00\x00\x00a";
pub(crate) const UTF_32_PREFIX_U32_BIG_SHORT_DATA: &[u8; 8] =
    b"\x00\x00\x00\x02\x00\x00\x00a";
pub(crate) const UTF_32_PREFIX_U32_7BIT_BIG_SHORT_DATA: &[u8; 5] = b"\x02\x00\x00\x00a";

// -------------%<-------------%<------|------->%------------->%-------------

// ------------------------------------------
// ---------- Buffer is too small -----------
// ------------------------------------------
//
// Error: incomplete

// ---------- Buffer is too small (UTF-8 little)
pub(crate) const UTF_8_FIXED_FORCE_ZERO_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_8_FIXED_ALLOW_NO_ZERO_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_8_PREFIX_U8_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_8_PREFIX_U16_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_8_PREFIX_U32_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_8_PREFIX_U32_7BIT_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_8_ZERO_ENDED_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];

// ---------- Buffer is too small (UTF-16 little)
pub(crate) const UTF_16_FIXED_FORCE_ZERO_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_16_FIXED_ALLOW_NO_ZERO_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_16_PREFIX_U8_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_16_PREFIX_U16_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_16_PREFIX_U32_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_16_PREFIX_U32_7BIT_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_16_ZERO_ENDED_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];

// ---------- Buffer is too small (UTF-32 little)
pub(crate) const UTF_32_FIXED_FORCE_ZERO_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_32_FIXED_ALLOW_NO_ZERO_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_32_PREFIX_U8_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_32_PREFIX_U16_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_32_PREFIX_U32_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_32_PREFIX_U32_7BIT_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_32_ZERO_ENDED_LITTLE_SMALL_BUFFER: &[u8; 0] = &[];

// ---------- Buffer is too small (UTF-8 big)
pub(crate) const UTF_8_FIXED_FORCE_ZERO_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_8_FIXED_ALLOW_NO_ZERO_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_8_PREFIX_U8_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_8_PREFIX_U16_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_8_PREFIX_U32_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_8_PREFIX_U32_7BIT_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_8_ZERO_ENDED_BIG_SMALL_BUFFER: &[u8; 0] = &[];

// ---------- Buffer is too small (UTF-16 big)
pub(crate) const UTF_16_FIXED_FORCE_ZERO_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_16_FIXED_ALLOW_NO_ZERO_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_16_PREFIX_U8_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_16_PREFIX_U16_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_16_PREFIX_U32_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_16_PREFIX_U32_7BIT_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_16_ZERO_ENDED_BIG_SMALL_BUFFER: &[u8; 0] = &[];
// ---------- Buffer is too small  (UTF-32 little)
pub(crate) const UTF_32_FIXED_FORCE_ZERO_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_32_FIXED_ALLOW_NO_ZERO_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_32_PREFIX_U8_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_32_PREFIX_U16_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_32_PREFIX_U32_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_32_PREFIX_U32_7BIT_BIG_SMALL_BUFFER: &[u8; 0] = &[];
pub(crate) const UTF_32_ZERO_ENDED_BIG_SMALL_BUFFER: &[u8; 0] = &[];

// -------------%<-------------%<------|------->%------------->%-------------

// -------------------------------------------------
// ---------- Invalid length encoding --------------
// -------------------------------------------------
//
// Error: assertion
//
// * `StringLayout::FixedLength` — no length prefix
// * `StringLayout::ZeroEnded` — no length prefix
// * `StringLayout::LengthPrefix` (other than 32-7bit) — not applicable

// ---------- Invalid length encoding (UTF-8 little)
pub(crate) const UTF_8_PREFIX_U32_7BIT_LITTLE_INVALID_SIZE_ENCODING: &[u8; 5] =
    b"\xff\xff\xff\xff\xff";

// ---------- Invalid length encoding (UTF-16 little)
pub(crate) const UTF_16_PREFIX_U32_7BIT_LITTLE_INVALID_SIZE_ENCODING: &[u8; 5] =
    b"\xff\xff\xff\xff\xff";

// ---------- Invalid length encoding (UTF-32 little)
pub(crate) const UTF_32_PREFIX_U32_7BIT_LITTLE_INVALID_SIZE_ENCODING: &[u8; 5] =
    b"\xff\xff\xff\xff\xff";

// ---------- Invalid length encoding (UTF-8 big)
pub(crate) const UTF_8_PREFIX_U32_7BIT_BIG_INVALID_SIZE_ENCODING: &[u8; 5] =
    b"\xff\xff\xff\xff\xff";

// ---------- Invalid length encoding (UTF-16 big)
pub(crate) const UTF_16_PREFIX_U32_7BIT_BIG_INVALID_SIZE_ENCODING: &[u8; 5] =
    b"\xff\xff\xff\xff\xff";

// ---------- Invalid length encoding (UTF-32 big)
pub(crate) const UTF_32_PREFIX_U32_7BIT_BIG_INVALID_SIZE_ENCODING: &[u8; 5] =
    b"\xff\xff\xff\xff\xff";

// -------------%<-------------%<------|------->%------------->%-------------