qubit-codec-misc 0.8.2

Miscellaneous byte and text format codecs for Rust applications
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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Tests for the bidirectional codec trait.

use qubit_codec::Codec;
use qubit_codec::ValueDecoder;
use qubit_codec::ValueEncoder;
use qubit_codec_misc::CStringLiteralCodec;
use qubit_codec_misc::FormUrlencodedCodec;
use qubit_codec_misc::HexCodec;
use qubit_codec_misc::MiscCodecError;
use qubit_codec_misc::PercentCodec;

use crate::incomplete_required;
use crate::invalid_consumed;
use crate::invalid_source;

#[test]
fn test_codec_trait_decodes_and_encodes_percent_byte() {
    let mut codec = PercentCodec::new();
    let mut escaped = [0u8; 3];
    let mut raw = [0u8; 1];

    let (decoded_escape, escape_units) =
        unsafe { Codec::decode(&mut codec, b"%E4", 0).expect("percent escape should decode") };
    let (decoded_raw, raw_units) =
        unsafe { Codec::decode(&mut codec, b"~", 0).expect("unreserved byte should decode") };
    let escaped_units =
        unsafe { Codec::encode(&mut codec, &0xe4, &mut escaped, 0).expect("escaped byte should encode") };
    let unreserved_units =
        unsafe { Codec::encode(&mut codec, &b'~', &mut raw, 0).expect("unreserved byte should encode") };

    assert_eq!(0xe4, decoded_escape);
    assert_eq!(3, escape_units.get());
    assert_eq!(b'~', decoded_raw);
    assert_eq!(1, raw_units.get());
    assert_eq!(3, escaped_units);
    assert_eq!(b"%E4", &escaped);
    assert_eq!(1, unreserved_units);
    assert_eq!(b"~", &raw);
    assert_eq!(1, <PercentCodec as Codec>::MIN_UNITS_PER_VALUE);
    assert_eq!(3, <PercentCodec as Codec>::MAX_ENCODE_UNITS_PER_VALUE);
    assert_eq!(3, <PercentCodec as Codec>::MAX_DECODE_UNITS_PER_VALUE);
}

#[test]
fn test_codec_trait_decodes_available_percent_byte() {
    let mut codec = PercentCodec::new();

    let raw = unsafe { Codec::decode(&mut codec, b"A", 0) }.expect("raw byte should decode");
    let (decoded, consumed) = raw;
    assert_eq!(b'A', decoded);
    assert_eq!(1, consumed.get());

    let incomplete =
        unsafe { Codec::decode(&mut codec, b"%E", 0) }.expect_err("partial percent escape should be incomplete");
    assert_eq!(3, incomplete_required(incomplete));

    let malformed = unsafe { Codec::decode(&mut codec, b"%Ez", 0) }.expect_err("malformed percent escape should fail");
    assert_eq!(Some(3), invalid_consumed(malformed));
    let malformed = unsafe { Codec::decode(&mut codec, b"%Ez", 0) }.expect_err("malformed percent escape should fail");
    let malformed = invalid_source(malformed);
    assert!(matches!(malformed, MiscCodecError::InvalidEscape { index: 0, .. }));
}

fn assert_invalid_short_percent_prefix<C>(mut codec: C)
where
    C: Codec<Value = u8, Unit = u8, DecodeError = MiscCodecError>,
{
    for input in [b"!%z".as_slice(), b"!%/", b"!%\xff"] {
        // SAFETY: index 1 has two readable units, exceeding the one-unit minimum.
        let error = unsafe { Codec::decode(&mut codec, input, 1) }.unwrap_err();
        assert_eq!(Some(2), error.consumed_units().map(|width| width.get()));
        assert!(matches!(
            error.invalid_source(),
            Some(MiscCodecError::InvalidEscape { index: 1, .. })
        ));
    }
    // SAFETY: both slices contain at least one readable unit at index zero.
    let partial = unsafe { Codec::decode(&mut codec, b"%A", 0) }.unwrap_err();
    assert_eq!(3, incomplete_required(partial));
    // SAFETY: the slice contains one readable unit at index zero.
    let marker = unsafe { Codec::decode(&mut codec, b"%", 0) }.unwrap_err();
    assert_eq!(3, incomplete_required(marker));
}

#[test]
fn test_percent_codecs_reject_impossible_short_prefixes() {
    assert_invalid_short_percent_prefix(PercentCodec::new());
    assert_invalid_short_percent_prefix(FormUrlencodedCodec::new());
}

#[test]
fn test_codec_trait_uses_exact_percent_widths_and_eof_rules() {
    let mut percent = PercentCodec::new();
    assert_eq!(1, Codec::encode_len(&percent, &b'A'));
    assert_eq!(3, Codec::encode_len(&percent, &0xe4));

    let (decoded, consumed) =
        unsafe { Codec::decode_eof(&mut percent, b"A", 0).expect("EOF raw percent byte should decode") };
    assert_eq!(b'A', decoded);
    assert_eq!(1, consumed.get());

    let invalid =
        unsafe { Codec::decode_eof(&mut percent, b"%A", 0) }.expect_err("EOF truncated percent escape should fail");
    assert!(matches!(
        invalid_source(invalid),
        MiscCodecError::InvalidEscape { index: 0, .. }
    ));
    let invalid = unsafe { Codec::decode_eof(&mut percent, b"%", 0) }.expect_err("EOF percent marker should fail");
    assert_eq!(Some(1), invalid_consumed(invalid));
    let invalid =
        unsafe { Codec::decode_eof(&mut percent, b"%A", 0) }.expect_err("EOF partial percent escape should fail");
    assert_eq!(Some(2), invalid_consumed(invalid));
}

#[test]
fn test_codec_trait_decodes_and_encodes_form_urlencoded_byte() {
    let mut codec = FormUrlencodedCodec::new();
    let mut plus_output = [0u8; 1];
    let mut raw_output = [0u8; 3];
    let mut escaped_output = [0u8; 3];

    let (decoded_plus, consumed) =
        unsafe { Codec::decode(&mut codec, b"+", 0).expect("form plus should decode as space") };
    let (decoded_escape, escape_consumed) =
        unsafe { Codec::decode(&mut codec, b"%E4", 0).expect("form escape should decode") };
    let (decoded_raw, raw_consumed) =
        unsafe { Codec::decode(&mut codec, b"~", 0).expect("form raw byte should decode") };
    let plus_written =
        unsafe { Codec::encode(&mut codec, &b' ', &mut plus_output, 0).expect("space should encode as plus") };
    let raw_written = unsafe { Codec::encode(&mut codec, &b'~', &mut raw_output, 0).expect("raw byte should encode") };
    let escaped_written =
        unsafe { Codec::encode(&mut codec, &0xe4, &mut escaped_output, 0).expect("escaped byte should encode") };

    assert_eq!(b' ', decoded_plus);
    assert_eq!(1, consumed.get());
    assert_eq!(0xe4, decoded_escape);
    assert_eq!(3, escape_consumed.get());
    assert_eq!(b'~', decoded_raw);
    assert_eq!(1, raw_consumed.get());
    assert_eq!(1, plus_written);
    assert_eq!(b"+", &plus_output);
    assert_eq!(3, raw_written);
    assert_eq!(b"%7E", &raw_output);
    assert_eq!(3, escaped_written);
    assert_eq!(b"%E4", &escaped_output);
    assert_eq!(1, <FormUrlencodedCodec as Codec>::MIN_UNITS_PER_VALUE,);
    assert_eq!(3, <FormUrlencodedCodec as Codec>::MAX_ENCODE_UNITS_PER_VALUE,);
    assert_eq!(3, <FormUrlencodedCodec as Codec>::MAX_DECODE_UNITS_PER_VALUE,);
}

#[test]
fn test_codec_trait_decodes_available_form_urlencoded_byte() {
    let mut codec = FormUrlencodedCodec::new();

    let plus = unsafe { Codec::decode(&mut codec, b"+", 0) }.expect("plus should decode to space");
    let (decoded, consumed) = plus;
    assert_eq!(b' ', decoded);
    assert_eq!(1, consumed.get());

    let incomplete =
        unsafe { Codec::decode(&mut codec, b"%", 0) }.expect_err("partial form escape should be incomplete");
    assert_eq!(3, incomplete_required(incomplete));

    let eof = unsafe { Codec::decode_eof(&mut codec, b"%", 0) }.expect_err("EOF form escape should be invalid");
    assert_eq!(Some(1), invalid_consumed(eof));
    let eof = unsafe { Codec::decode_eof(&mut codec, b"%", 0) }.expect_err("EOF form escape should be invalid");
    assert!(matches!(
        invalid_source(eof),
        MiscCodecError::InvalidEscape { index: 0, .. }
    ));
    let eof =
        unsafe { Codec::decode_eof(&mut codec, b"%A", 0) }.expect_err("EOF partial form escape should be invalid");
    assert_eq!(Some(2), invalid_consumed(eof));
}

#[test]
fn test_form_codec_uses_exact_widths_and_eof_rules() {
    let mut codec = FormUrlencodedCodec::new();
    assert_eq!(1, Codec::encode_len(&codec, &b'*'));
    assert_eq!(3, Codec::encode_len(&codec, &b'~'));

    let (decoded, consumed) = unsafe { Codec::decode_eof(&mut codec, b"+", 0).expect("EOF form plus should decode") };
    assert_eq!(b' ', decoded);
    assert_eq!(1, consumed.get());

    let invalid =
        unsafe { Codec::decode_eof(&mut codec, b"%z0", 0) }.expect_err("EOF malformed form escape should fail");
    assert_eq!(Some(3), invalid_consumed(invalid));
    let invalid =
        unsafe { Codec::decode_eof(&mut codec, b"%z0", 0) }.expect_err("EOF malformed form escape should fail");
    assert!(matches!(
        invalid_source(invalid),
        MiscCodecError::InvalidEscape { index: 0, .. }
    ));
}

#[test]
fn test_codec_trait_decodes_and_encodes_c_string_literal_byte() {
    let mut codec = CStringLiteralCodec::new();
    let mut escaped = [0u8; 4];
    let mut simple = [0u8; 2];

    let (decoded_hex, hex_units) =
        unsafe { Codec::decode(&mut codec, br"\xD0", 0).expect("hex byte escape should decode") };
    let (decoded_newline, newline_units) =
        unsafe { Codec::decode(&mut codec, br"\n", 0).expect("simple escape should decode") };
    let escaped_units =
        unsafe { Codec::encode(&mut codec, &0xd0, &mut escaped, 0).expect("non-printable byte should encode") };
    let simple_units = unsafe { Codec::encode(&mut codec, &b'\n', &mut simple, 0).expect("newline should encode") };

    assert_eq!(0xd0, decoded_hex);
    assert_eq!(4, hex_units.get());
    assert_eq!(b'\n', decoded_newline);
    assert_eq!(2, newline_units.get());
    assert_eq!(4, escaped_units);
    assert_eq!(br"\xD0", &escaped);
    assert_eq!(2, simple_units);
    assert_eq!(br"\n", &simple);
    assert_eq!(1, <CStringLiteralCodec as Codec>::MIN_UNITS_PER_VALUE,);
    assert_eq!(4, <CStringLiteralCodec as Codec>::MAX_ENCODE_UNITS_PER_VALUE,);
    assert_eq!(10, <CStringLiteralCodec as Codec>::MAX_DECODE_UNITS_PER_VALUE,);
}

#[test]
fn test_codec_trait_decodes_available_c_string_literal_byte() {
    let mut codec = CStringLiteralCodec::new();

    let raw = unsafe { Codec::decode(&mut codec, br"A", 0) }.expect("raw C string byte should decode");
    let (decoded, consumed) = raw;
    assert_eq!(b'A', decoded);
    assert_eq!(1, consumed.get());

    let simple = unsafe { Codec::decode(&mut codec, br"\n", 0) }.expect("simple C escape should decode");
    let (decoded, consumed) = simple;
    assert_eq!(b'\n', decoded);
    assert_eq!(2, consumed.get());

    let eof_hex = unsafe { Codec::decode_eof(&mut codec, br"\xA", 0) }.expect("EOF-closed hex escape should decode");
    let (decoded, consumed) = eof_hex;
    assert_eq!(0x0a, decoded);
    assert_eq!(3, consumed.get());

    let terminated_hex =
        unsafe { Codec::decode(&mut codec, br"\xAG", 0) }.expect("terminated hex escape should decode");
    let (decoded, consumed) = terminated_hex;
    assert_eq!(0x0a, decoded);
    assert_eq!(3, consumed.get());

    let eof_octal =
        unsafe { Codec::decode_eof(&mut codec, br"\12", 0) }.expect("EOF-closed octal escape should decode");
    let (decoded, consumed) = eof_octal;
    assert_eq!(0o12, decoded);
    assert_eq!(3, consumed.get());

    let terminated_octal =
        unsafe { Codec::decode(&mut codec, br"\12G", 0) }.expect("terminated octal escape should decode");
    let (decoded, consumed) = terminated_octal;
    assert_eq!(0o12, decoded);
    assert_eq!(3, consumed.get());

    let malformed = unsafe { Codec::decode(&mut codec, br"\z", 0) }.expect_err("unsupported C escape should fail");
    assert_eq!(Some(2), invalid_consumed(malformed));
    let malformed = unsafe { Codec::decode(&mut codec, br"\z", 0) }.expect_err("unsupported C escape should fail");
    let malformed = invalid_source(malformed);
    assert!(matches!(malformed, MiscCodecError::InvalidEscape { index: 0, .. }));
}

#[test]
fn test_codec_trait_decodes_c_string_literal_escape_variants() {
    let mut codec = CStringLiteralCodec::new();
    let cases: &[(&[u8], u8, usize)] = &[
        (br"A", b'A', 1),
        (br"\ ", b' ', 2),
        (br"\'", b'\'', 2),
        (br#"\""#, b'"', 2),
        (br"\?", b'?', 2),
        (br"\\", b'\\', 2),
        (br"\a", 0x07, 2),
        (br"\b", 0x08, 2),
        (br"\f", 0x0c, 2),
        (br"\r", b'\r', 2),
        (br"\t", b'\t', 2),
        (br"\v", 0x0b, 2),
        (br"\x1Z", 0x01, 3),
        (br"\u0022", b'"', 6),
        (br"\U00000021", b'!', 10),
        (br"\377", 0xff, 4),
    ];

    for (input, expected, expected_units) in cases {
        let (decoded, consumed) = unsafe { Codec::decode(&mut codec, input, 0).expect("C escape should decode") };
        assert_eq!(*expected, decoded, "input {input:?}");
        assert_eq!(*expected_units, consumed.get(), "input {input:?}");
    }

    for (input, expected, expected_units) in [(br"\xA" as &[u8], 0x0a, 3), (br"\7" as &[u8], 0x07, 2)] {
        let (decoded, consumed) =
            unsafe { Codec::decode_eof(&mut codec, input, 0).expect("EOF C escape should decode") };
        assert_eq!(expected, decoded, "input {input:?}");
        assert_eq!(expected_units, consumed.get(), "input {input:?}");
    }
}

#[test]
fn test_codec_trait_reports_c_string_literal_byte_errors() {
    let mut codec = CStringLiteralCodec::new();
    let invalid_raw = unsafe { Codec::decode(&mut codec, &[0xff], 0) }.expect_err("invalid raw byte should fail");
    let unsupported = unsafe { Codec::decode(&mut codec, br"\z", 0) }.expect_err("unsupported escape should fail");
    let trailing_escape =
        unsafe { Codec::decode(&mut codec, br"\", 0) }.expect_err("trailing escape should be incomplete");
    let short_hex_marker =
        unsafe { Codec::decode(&mut codec, br"\x", 0) }.expect_err("short hex marker should be incomplete");
    let missing_hex = unsafe { Codec::decode(&mut codec, br"\xz", 0) }.expect_err("missing hex digit should fail");
    let incomplete_universal =
        unsafe { Codec::decode(&mut codec, br"\u00", 0) }.expect_err("incomplete universal escape should fail");
    let incomplete_hex =
        unsafe { Codec::decode(&mut codec, br"\xA", 0) }.expect_err("extendable hex escape should be incomplete");
    let incomplete_octal =
        unsafe { Codec::decode(&mut codec, br"\7", 0) }.expect_err("extendable octal escape should be incomplete");
    let invalid_universal_digit =
        unsafe { Codec::decode(&mut codec, br"\u00zz", 0) }.expect_err("invalid universal digit should fail");
    let invalid_long_universal_digit =
        unsafe { Codec::decode(&mut codec, br"\U0000000z", 0) }.expect_err("invalid long universal digit should fail");
    let oversized_universal =
        unsafe { Codec::decode(&mut codec, br"\u0100", 0) }.expect_err("oversized universal escape should fail");
    let eof_invalid =
        unsafe { Codec::decode_eof(&mut codec, br"\z", 0) }.expect_err("EOF unsupported C escape should fail");

    let invalid_raw = invalid_source(invalid_raw);
    let unsupported = invalid_source(unsupported);
    let missing_hex = invalid_source(missing_hex);
    let invalid_universal_digit = invalid_source(invalid_universal_digit);
    let invalid_long_universal_digit = invalid_source(invalid_long_universal_digit);
    let oversized_universal = invalid_source(oversized_universal);
    let eof_invalid = invalid_source(eof_invalid);
    assert!(matches!(invalid_raw, MiscCodecError::InvalidCharacter { index: 0, .. }));
    assert!(matches!(unsupported, MiscCodecError::InvalidEscape { index: 0, .. }));
    assert_eq!(2, incomplete_required(trailing_escape));
    assert_eq!(3, incomplete_required(short_hex_marker));
    assert!(matches!(missing_hex, MiscCodecError::InvalidEscape { index: 0, .. }));
    assert_eq!(6, incomplete_required(incomplete_universal));
    assert_eq!(4, incomplete_required(incomplete_hex));
    assert_eq!(3, incomplete_required(incomplete_octal));
    assert!(matches!(
        invalid_universal_digit,
        MiscCodecError::InvalidDigit {
            radix: 16,
            index: 4,
            character: 'z'
        }
    ));
    assert!(matches!(
        invalid_long_universal_digit,
        MiscCodecError::InvalidDigit {
            radix: 16,
            index: 9,
            character: 'z'
        }
    ));
    assert!(matches!(
        oversized_universal,
        MiscCodecError::InvalidEscape { index: 0, .. }
    ));
    assert!(matches!(eof_invalid, MiscCodecError::InvalidEscape { index: 0, .. }));
}

#[test]
fn test_codec_trait_rejects_invalid_c_universal_short_prefixes() {
    let mut codec = CStringLiteralCodec::new();
    let cases: &[(&[u8], usize, usize)] = &[
        (br"!\uZ", 1, 3),
        (br"!\u0Z", 1, 4),
        (br"!\U000Z", 1, 6),
        (br"\uZ", 0, 2),
        (br"\u1Z", 0, 3),
    ];

    for (input, input_index, error_index) in cases {
        // SAFETY: each input has at least two readable units at input_index.
        let error = unsafe { Codec::decode(&mut codec, input, *input_index) }
            .expect_err("an invalid visible universal escape digit should fail immediately");
        assert!(matches!(
            error.invalid_source(),
            Some(MiscCodecError::InvalidDigit {
                radix: 16,
                index,
                character: 'Z'
            }) if index == error_index
        ));
        assert!(
            error
                .consumed_units()
                .is_none_or(|consumed| consumed.get() <= input.len() - input_index)
        );
    }

    for (input, required) in [
        (br"\u".as_slice(), 6),
        (br"\u0", 6),
        (br"\u00", 6),
        (br"\u00F", 6),
        (br"\U", 10),
        (br"\U000000", 10),
        (br"\U000000F", 10),
    ] {
        // SAFETY: each input has at least one readable unit at index zero.
        let incomplete = unsafe { Codec::decode(&mut codec, input, 0) }
            .expect_err("a valid short universal escape should request more input");
        assert_eq!(required, incomplete_required(incomplete));
    }

    // SAFETY: the input contains a readable escape marker at index zero.
    let eof = unsafe { Codec::decode_eof(&mut codec, br"\u12", 0) }
        .expect_err("EOF should retain the existing truncated-escape error");
    assert!(matches!(
        invalid_source(eof),
        MiscCodecError::InvalidEscape {
            index: 0,
            escape,
            reason
        } if escape == r"\u12" && reason == "incomplete universal character escape"
    ));

    let complete = CStringLiteralCodec::new()
        .decode(r"\u12")
        .expect_err("complete-text decoding should retain its truncated-escape error");
    assert!(matches!(
        complete,
        MiscCodecError::InvalidEscape {
            index: 0,
            escape,
            reason
        } if escape == r"\u12" && reason == "incomplete escape sequence; expected at least 6 units"
    ));
}

#[test]
fn test_c_universal_escape_complete_values_decode() {
    let mut codec = CStringLiteralCodec::new();
    for (input, width) in [(br"\u00FF".as_slice(), 6), (br"\U000000FF", 10)] {
        let (decoded, consumed) =
            unsafe { Codec::decode(&mut codec, input, 0) }.expect("complete one-byte universal value should decode");
        assert_eq!(255, decoded, "input={input:?}");
        assert_eq!(width, consumed.get(), "input={input:?}");
    }
}

#[test]
fn test_c_universal_impossible_prefixes_are_invalid() {
    for fragment in [r"\u1", r"\u01", r"\u12", r"\U1", r"\U000001"] {
        for index in [0, 3] {
            let mut input = vec![b'!'; index];
            input.extend_from_slice(fragment.as_bytes());
            let mut codec = CStringLiteralCodec::new();
            // SAFETY: a readable escape marker exists at index.
            let error = unsafe { Codec::decode(&mut codec, &input, index) }.unwrap_err();
            assert!(
                matches!(
                    error.invalid_source(),
                    Some(MiscCodecError::InvalidEscape { index: actual, escape, reason })
                        if *actual == index && escape == fragment
                            && reason == "universal character value must fit in one byte"
                ),
                "fragment={fragment}, index={index}, error={error:?}"
            );
            assert!(
                error
                    .consumed_units()
                    .is_none_or(|width| width.get() <= input.len() - index)
            );
        }
    }
}

#[test]
fn test_c_byte_encoding_contract_is_exhaustive() {
    let mut codec = CStringLiteralCodec::new();
    for byte in 0_u8..=u8::MAX {
        let expected = CStringLiteralCodec::encode(&codec, &[byte]);
        let required = Codec::encode_len(&codec, &byte);
        assert_eq!(expected.len(), required, "byte={byte:#04x}");
        assert!(required <= <CStringLiteralCodec as Codec>::MAX_ENCODE_UNITS_PER_VALUE);

        for index in [0, 3] {
            let mut storage = [0xa5_u8; 9];
            // SAFETY: the writable slice includes exactly the required units at `index`.
            let written = unsafe { Codec::encode(&mut codec, &byte, &mut storage[..index + required], index) }
                .expect("every byte is encodable");
            assert_eq!(required, written, "byte={byte:#04x}, index={index}");
            assert_eq!(expected.as_bytes(), &storage[index..index + written]);
            assert!(storage[..index].iter().all(|unit| *unit == 0xa5));
            assert!(storage[index + written..].iter().all(|unit| *unit == 0xa5));

            // SAFETY: the encoded value is nonempty and the slice ends at known EOF.
            let (decoded, consumed) = unsafe { Codec::decode_eof(&mut codec, &storage[..index + written], index) }
                .expect("encoded byte decodes at EOF");
            assert_eq!(byte, decoded);
            assert_eq!(written, consumed.get());
        }
    }
}

fn assert_percent_byte_contract<C>(mut codec: C, form: bool)
where
    C: Codec<Value = u8, Unit = u8, EncodeError = MiscCodecError, DecodeError = MiscCodecError>,
{
    for byte in 0_u8..=u8::MAX {
        let unescaped = byte.is_ascii_alphanumeric()
            || if form {
                b"*-._".contains(&byte)
            } else {
                b"-._~".contains(&byte)
            };
        let expected = if form && byte == b' ' {
            "+".to_owned()
        } else if unescaped {
            char::from(byte).to_string()
        } else {
            format!("%{byte:02X}")
        };

        let required = Codec::encode_len(&codec, &byte);
        assert_eq!(expected.len(), required, "byte={byte:#04x}, form={form}");
        assert!(required <= C::MAX_ENCODE_UNITS_PER_VALUE);

        for index in [0, 3] {
            let mut storage = [0xa5_u8; 9];
            // SAFETY: the writable slice contains exactly encode_len units at index.
            let written = unsafe { Codec::encode(&mut codec, &byte, &mut storage[..index + required], index) }.unwrap();
            assert_eq!(required, written, "byte={byte:#04x}, index={index}");
            assert_eq!(expected.as_bytes(), &storage[index..index + written]);
            assert!(storage[..index].iter().all(|unit| *unit == 0xa5));
            assert!(storage[index + written..].iter().all(|unit| *unit == 0xa5));

            // SAFETY: the encoded value is nonempty and ends at known EOF.
            let (decoded, consumed) =
                unsafe { Codec::decode_eof(&mut codec, &storage[..index + written], index) }.unwrap();
            assert_eq!(byte, decoded);
            assert_eq!(written, consumed.get());
        }
    }
}

#[test]
fn test_percent_byte_encoding_contract_is_exhaustive() {
    assert_percent_byte_contract(PercentCodec::new(), false);
}

#[test]
fn test_form_byte_encoding_contract_is_exhaustive() {
    assert_percent_byte_contract(FormUrlencodedCodec::new(), true);
}

#[test]
fn test_codec_trait_encodes_c_string_literal_escape_variants() {
    let mut codec = CStringLiteralCodec::new();
    let cases: &[(u8, &[u8])] = &[
        (b'A', b"A"),
        (b'\'', br"\'"),
        (b'"', br#"\""#),
        (b'?', br"\?"),
        (b'\\', br"\\"),
        (0x07, br"\a"),
        (0x08, br"\b"),
        (0x0c, br"\f"),
        (b'\r', br"\r"),
        (b'\t', br"\t"),
        (0x0b, br"\v"),
        (0xff, br"\xFF"),
    ];

    for (byte, expected) in cases {
        let mut output = [0u8; 4];
        let written =
            unsafe { Codec::encode(&mut codec, byte, &mut output, 0).expect("C string literal byte should encode") };
        assert_eq!(expected.len(), codec.encode_len(byte));
        assert_eq!(*expected, &output[..written], "byte {byte:#04x}");
    }
}

#[test]
fn test_value_traits_remain_convenience_layer() {
    let mut codec = HexCodec::upper().with_byte_prefix("0x").with_separator(" ");

    let encoded = ValueEncoder::<[u8]>::encode(&mut codec, &[0x00, 0x7f, 0xff]).expect("hex value encode should work");
    let decoded = ValueDecoder::<str>::decode(&mut codec, &encoded).expect("hex value decode should work");

    assert_eq!("0x00 0x7F 0xFF", encoded);
    assert_eq!(vec![0x00, 0x7f, 0xff], decoded);
}