oxicode 0.2.2

A modern binary serialization library - successor to bincode
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
//! Advanced tests for large collection encoding in OxiCode.
//!
//! Covers 22 scenarios exercising large Vec encoding, fixed-int configs,
//! big-endian configs, varint boundaries, partial-decode failures, and more.

#![allow(
    clippy::approx_constant,
    clippy::useless_vec,
    clippy::len_zero,
    clippy::unnecessary_cast,
    clippy::redundant_closure,
    clippy::too_many_arguments,
    clippy::type_complexity,
    clippy::needless_borrow,
    clippy::enum_variant_names,
    clippy::upper_case_acronyms,
    clippy::inconsistent_digit_grouping,
    clippy::unit_cmp,
    clippy::assertions_on_constants,
    clippy::iter_on_single_items,
    clippy::expect_fun_call,
    clippy::redundant_pattern_matching,
    variant_size_differences,
    clippy::absurd_extreme_comparisons,
    clippy::nonminimal_bool,
    clippy::for_kv_map,
    clippy::needless_range_loop,
    clippy::single_match,
    clippy::collapsible_if,
    clippy::needless_return,
    clippy::redundant_clone,
    clippy::map_entry,
    clippy::match_single_binding,
    clippy::bool_comparison,
    clippy::derivable_impls,
    clippy::manual_range_contains,
    clippy::needless_borrows_for_generic_args,
    clippy::manual_map,
    clippy::vec_init_then_push,
    clippy::identity_op,
    clippy::manual_flatten,
    clippy::single_char_pattern,
    clippy::search_is_some,
    clippy::option_map_unit_fn,
    clippy::while_let_on_iterator,
    clippy::clone_on_copy,
    clippy::box_collection,
    clippy::redundant_field_names,
    clippy::ptr_arg,
    clippy::large_enum_variant,
    clippy::match_ref_pats,
    clippy::needless_pass_by_value,
    clippy::unused_unit,
    clippy::let_and_return,
    clippy::suspicious_else_formatting,
    clippy::manual_strip,
    clippy::match_like_matches_macro,
    clippy::from_over_into,
    clippy::wrong_self_convention,
    clippy::inherent_to_string,
    clippy::new_without_default,
    clippy::unnecessary_wraps,
    clippy::field_reassign_with_default,
    clippy::manual_find,
    clippy::unnecessary_lazy_evaluations,
    clippy::should_implement_trait,
    clippy::missing_safety_doc,
    clippy::unusual_byte_groupings,
    clippy::bool_assert_comparison,
    clippy::zero_prefixed_literal,
    clippy::await_holding_lock,
    clippy::manual_saturating_arithmetic,
    clippy::explicit_counter_loop,
    clippy::needless_lifetimes,
    clippy::single_component_path_imports,
    clippy::uninlined_format_args,
    clippy::iter_cloned_collect,
    clippy::manual_str_repeat,
    clippy::excessive_precision,
    clippy::precedence,
    clippy::unnecessary_literal_unwrap
)]
use oxicode::{
    config, decode_from_slice, decode_from_slice_with_config, encode_to_vec,
    encode_to_vec_with_config,
};

// ---------------------------------------------------------------------------
// 1. Vec<u8> with 1000 elements roundtrip
// ---------------------------------------------------------------------------
#[test]
fn test_vec_u8_1000_roundtrip() {
    let original: Vec<u8> = (0u16..1000).map(|i| (i % 256) as u8).collect();
    let bytes = encode_to_vec(&original).expect("Failed to encode Vec<u8> with 1000 elements");
    let (decoded, consumed): (Vec<u8>, usize) =
        decode_from_slice(&bytes).expect("Failed to decode Vec<u8> with 1000 elements");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
}

// ---------------------------------------------------------------------------
// 2. Vec<u32> with 1000 elements roundtrip
// ---------------------------------------------------------------------------
#[test]
fn test_vec_u32_1000_roundtrip() {
    let original: Vec<u32> = (0u32..1000).map(|i| i * 3 + 7).collect();
    let bytes = encode_to_vec(&original).expect("Failed to encode Vec<u32> with 1000 elements");
    let (decoded, consumed): (Vec<u32>, usize) =
        decode_from_slice(&bytes).expect("Failed to decode Vec<u32> with 1000 elements");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
}

// ---------------------------------------------------------------------------
// 3. Vec<u64> with 500 elements roundtrip
// ---------------------------------------------------------------------------
#[test]
fn test_vec_u64_500_roundtrip() {
    let original: Vec<u64> = (0u64..500).map(|i| i * i + 1).collect();
    let bytes = encode_to_vec(&original).expect("Failed to encode Vec<u64> with 500 elements");
    let (decoded, consumed): (Vec<u64>, usize) =
        decode_from_slice(&bytes).expect("Failed to decode Vec<u64> with 500 elements");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
}

// ---------------------------------------------------------------------------
// 4. Vec<String> with 100 elements roundtrip
// ---------------------------------------------------------------------------
#[test]
fn test_vec_string_100_roundtrip() {
    let original: Vec<String> = (0u32..100).map(|i| format!("item_{:04}", i)).collect();
    let bytes = encode_to_vec(&original).expect("Failed to encode Vec<String> with 100 elements");
    let (decoded, consumed): (Vec<String>, usize) =
        decode_from_slice(&bytes).expect("Failed to decode Vec<String> with 100 elements");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
}

// ---------------------------------------------------------------------------
// 5. Vec<u8> with 10000 elements roundtrip
// ---------------------------------------------------------------------------
#[test]
fn test_vec_u8_10000_roundtrip() {
    let original: Vec<u8> = (0u32..10000).map(|i| (i % 256) as u8).collect();
    let bytes = encode_to_vec(&original).expect("Failed to encode Vec<u8> with 10000 elements");
    let (decoded, consumed): (Vec<u8>, usize) =
        decode_from_slice(&bytes).expect("Failed to decode Vec<u8> with 10000 elements");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
}

// ---------------------------------------------------------------------------
// 6. Vec<u8> consumed equals encoded length for 1000 elements
// ---------------------------------------------------------------------------
#[test]
fn test_vec_u8_consumed_equals_encoded_len() {
    let original: Vec<u8> = (0u16..1000).map(|i| (i % 256) as u8).collect();
    let bytes = encode_to_vec(&original).expect("Failed to encode Vec<u8> for consumed check");
    let (_decoded, consumed): (Vec<u8>, usize) =
        decode_from_slice(&bytes).expect("Failed to decode Vec<u8> for consumed check");
    assert_eq!(
        consumed,
        bytes.len(),
        "consumed byte count must equal total encoded length"
    );
}

// ---------------------------------------------------------------------------
// 7. Vec<u32> with fixed-int config (1000 elements)
// ---------------------------------------------------------------------------
#[test]
fn test_vec_u32_fixed_int_config_1000() {
    let original: Vec<u32> = (0u32..1000).collect();
    let cfg = config::standard().with_fixed_int_encoding();
    let bytes =
        encode_to_vec_with_config(&original, cfg).expect("Failed to encode Vec<u32> fixed-int");
    let (decoded, consumed): (Vec<u32>, usize) =
        decode_from_slice_with_config(&bytes, cfg).expect("Failed to decode Vec<u32> fixed-int");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
}

// ---------------------------------------------------------------------------
// 8. Vec<u64> with fixed-int config (500 elements) — verify 8 bytes per element
// ---------------------------------------------------------------------------
#[test]
fn test_vec_u64_fixed_int_8_bytes_per_element() {
    let original: Vec<u64> = (0u64..500).collect();
    let cfg = config::standard().with_fixed_int_encoding();
    let bytes =
        encode_to_vec_with_config(&original, cfg).expect("Failed to encode Vec<u64> fixed-int");
    let (decoded, consumed): (Vec<u64>, usize) =
        decode_from_slice_with_config(&bytes, cfg).expect("Failed to decode Vec<u64> fixed-int");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
    // Each u64 is exactly 8 bytes with fixed-int encoding; plus varint length prefix.
    // The data portion must be at least 500 * 8 bytes.
    assert!(
        bytes.len() >= 500 * 8,
        "fixed-int Vec<u64> must be at least 500*8 bytes, got {}",
        bytes.len()
    );
}

// ---------------------------------------------------------------------------
// 9. Vec<bool> with 1000 elements roundtrip
// ---------------------------------------------------------------------------
#[test]
fn test_vec_bool_1000_roundtrip() {
    let original: Vec<bool> = (0u32..1000).map(|i| i % 2 == 0).collect();
    let bytes = encode_to_vec(&original).expect("Failed to encode Vec<bool> with 1000 elements");
    let (decoded, consumed): (Vec<bool>, usize) =
        decode_from_slice(&bytes).expect("Failed to decode Vec<bool> with 1000 elements");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
}

// ---------------------------------------------------------------------------
// 10. Vec<i32> with negative values (1000 elements)
// ---------------------------------------------------------------------------
#[test]
fn test_vec_i32_negative_1000_roundtrip() {
    let original: Vec<i32> = (-500i32..500).collect();
    let bytes = encode_to_vec(&original).expect("Failed to encode Vec<i32> with negative values");
    let (decoded, consumed): (Vec<i32>, usize) =
        decode_from_slice(&bytes).expect("Failed to decode Vec<i32> with negative values");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
}

// ---------------------------------------------------------------------------
// 11. Vec<u8> all-zeros (10000 elements) roundtrip
// ---------------------------------------------------------------------------
#[test]
fn test_vec_u8_all_zeros_10000_roundtrip() {
    let original: Vec<u8> = vec![0u8; 10000];
    let bytes = encode_to_vec(&original).expect("Failed to encode Vec<u8> all-zeros");
    let (decoded, consumed): (Vec<u8>, usize) =
        decode_from_slice(&bytes).expect("Failed to decode Vec<u8> all-zeros");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
    assert!(decoded.iter().all(|&b| b == 0), "all bytes must be zero");
}

// ---------------------------------------------------------------------------
// 12. Vec<u8> all-255 (10000 elements) roundtrip
// ---------------------------------------------------------------------------
#[test]
fn test_vec_u8_all_255_10000_roundtrip() {
    let original: Vec<u8> = vec![255u8; 10000];
    let bytes = encode_to_vec(&original).expect("Failed to encode Vec<u8> all-255");
    let (decoded, consumed): (Vec<u8>, usize) =
        decode_from_slice(&bytes).expect("Failed to decode Vec<u8> all-255");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
    assert!(decoded.iter().all(|&b| b == 255), "all bytes must be 255");
}

// ---------------------------------------------------------------------------
// 13. Nested Vec<Vec<u8>> with 100 inner vecs
// ---------------------------------------------------------------------------
#[test]
fn test_nested_vec_vec_u8_100_roundtrip() {
    let original: Vec<Vec<u8>> = (0u8..100).map(|i| (0u8..i).collect::<Vec<u8>>()).collect();
    let bytes =
        encode_to_vec(&original).expect("Failed to encode nested Vec<Vec<u8>> with 100 inner vecs");
    let (decoded, consumed): (Vec<Vec<u8>>, usize) = decode_from_slice(&bytes)
        .expect("Failed to decode nested Vec<Vec<u8>> with 100 inner vecs");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
}

// ---------------------------------------------------------------------------
// 14. Vec<u32> deterministic values roundtrip (use 0..1000u32)
// ---------------------------------------------------------------------------
#[test]
fn test_vec_u32_deterministic_0_to_1000_roundtrip() {
    let original: Vec<u32> = (0u32..1000).collect();
    let bytes = encode_to_vec(&original).expect("Failed to encode Vec<u32> deterministic 0..1000");
    let (decoded, consumed): (Vec<u32>, usize) =
        decode_from_slice(&bytes).expect("Failed to decode Vec<u32> deterministic 0..1000");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
    for (idx, (&orig, &dec)) in original.iter().zip(decoded.iter()).enumerate() {
        assert_eq!(orig, dec, "element at index {} must match", idx);
    }
}

// ---------------------------------------------------------------------------
// 15. Large String (10000 chars) roundtrip
// ---------------------------------------------------------------------------
#[test]
fn test_large_string_10000_chars_roundtrip() {
    let original: String = "x".repeat(10000);
    let bytes = encode_to_vec(&original).expect("Failed to encode large String with 10000 chars");
    let (decoded, consumed): (String, usize) =
        decode_from_slice(&bytes).expect("Failed to decode large String with 10000 chars");
    assert_eq!(original, decoded);
    assert_eq!(decoded.len(), 10000);
    assert_eq!(consumed, bytes.len());
}

// ---------------------------------------------------------------------------
// 16. Vec<u64> with u64::MAX values roundtrip
// ---------------------------------------------------------------------------
#[test]
fn test_vec_u64_max_values_roundtrip() {
    let original: Vec<u64> = vec![u64::MAX; 100];
    let bytes = encode_to_vec(&original).expect("Failed to encode Vec<u64> with u64::MAX values");
    let (decoded, consumed): (Vec<u64>, usize) =
        decode_from_slice(&bytes).expect("Failed to decode Vec<u64> with u64::MAX values");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
    assert!(
        decoded.iter().all(|&v| v == u64::MAX),
        "all values must be u64::MAX"
    );
}

// ---------------------------------------------------------------------------
// 17. Vec<u32> encoding grows monotonically with size
// ---------------------------------------------------------------------------
#[test]
fn test_vec_u32_encoding_grows_monotonically() {
    let sizes = [10usize, 100, 500, 1000];
    let mut prev_len = 0usize;
    for &n in &sizes {
        let v: Vec<u32> = (0u32..n as u32).collect();
        let bytes = encode_to_vec(&v).expect("Failed to encode Vec<u32> for size growth test");
        assert!(
            bytes.len() > prev_len,
            "encoded length must grow: size {} produced {} bytes, prev was {}",
            n,
            bytes.len(),
            prev_len
        );
        prev_len = bytes.len();
    }
}

// ---------------------------------------------------------------------------
// 18. Vec<u8> with varint boundary sizes (255 and 256 elements)
// ---------------------------------------------------------------------------
#[test]
fn test_vec_u8_varint_boundary_255_and_256() {
    // 255-element vec
    let original_255: Vec<u8> = (0u8..255).collect();
    let bytes_255 =
        encode_to_vec(&original_255).expect("Failed to encode Vec<u8> with 255 elements");
    let (decoded_255, consumed_255): (Vec<u8>, usize) =
        decode_from_slice(&bytes_255).expect("Failed to decode Vec<u8> with 255 elements");
    assert_eq!(original_255, decoded_255);
    assert_eq!(consumed_255, bytes_255.len());

    // 256-element vec
    let original_256: Vec<u8> = (0u16..256).map(|i| i as u8).collect();
    let bytes_256 =
        encode_to_vec(&original_256).expect("Failed to encode Vec<u8> with 256 elements");
    let (decoded_256, consumed_256): (Vec<u8>, usize) =
        decode_from_slice(&bytes_256).expect("Failed to decode Vec<u8> with 256 elements");
    assert_eq!(original_256, decoded_256);
    assert_eq!(consumed_256, bytes_256.len());

    assert_eq!(decoded_255.len(), 255);
    assert_eq!(decoded_256.len(), 256);
}

// ---------------------------------------------------------------------------
// 19. Large Vec<u8> with big-endian config
// ---------------------------------------------------------------------------
#[test]
fn test_large_vec_u8_big_endian_config() {
    let original: Vec<u8> = (0u16..1000).map(|i| (i % 256) as u8).collect();
    let cfg = config::standard().with_big_endian();
    let bytes =
        encode_to_vec_with_config(&original, cfg).expect("Failed to encode Vec<u8> big-endian");
    let (decoded, consumed): (Vec<u8>, usize) =
        decode_from_slice_with_config(&bytes, cfg).expect("Failed to decode Vec<u8> big-endian");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
}

// ---------------------------------------------------------------------------
// 20. Vec<i64> with i64::MIN values roundtrip
// ---------------------------------------------------------------------------
#[test]
fn test_vec_i64_min_values_roundtrip() {
    let original: Vec<i64> = vec![i64::MIN; 100];
    let bytes = encode_to_vec(&original).expect("Failed to encode Vec<i64> with i64::MIN values");
    let (decoded, consumed): (Vec<i64>, usize) =
        decode_from_slice(&bytes).expect("Failed to decode Vec<i64> with i64::MIN values");
    assert_eq!(original, decoded);
    assert_eq!(consumed, bytes.len());
    assert!(
        decoded.iter().all(|&v| v == i64::MIN),
        "all values must be i64::MIN"
    );
}

// ---------------------------------------------------------------------------
// 21. Vec<f64> with 100 exact values roundtrip (whole numbers like 1.0, 2.0, …)
// ---------------------------------------------------------------------------
#[test]
fn test_vec_f64_exact_values_roundtrip() {
    let original: Vec<f64> = (1u32..=100).map(f64::from).collect();
    let bytes = encode_to_vec(&original).expect("Failed to encode Vec<f64> with exact values");
    let (decoded, consumed): (Vec<f64>, usize) =
        decode_from_slice(&bytes).expect("Failed to decode Vec<f64> with exact values");
    assert_eq!(original.len(), decoded.len());
    assert_eq!(consumed, bytes.len());
    for (idx, (&orig, &dec)) in original.iter().zip(decoded.iter()).enumerate() {
        assert_eq!(
            orig.to_bits(),
            dec.to_bits(),
            "f64 bit pattern must match at index {}",
            idx
        );
    }
}

// ---------------------------------------------------------------------------
// 22. Vec<u8> encode then decode partial (first part only) — must fail
// ---------------------------------------------------------------------------
#[test]
fn test_vec_u8_decode_truncated_fails() {
    // Encode a vec of 200 elements, then try to decode from only the first 100 bytes.
    // This should fail because the data is truncated.
    let original: Vec<u8> = (0u8..200).collect();
    let bytes = encode_to_vec(&original).expect("Failed to encode Vec<u8> with 200 elements");

    // Only use the first 100 bytes, which cannot represent the full 200-element vec.
    let truncated = &bytes[..100];
    let result: Result<(Vec<u8>, usize), _> = decode_from_slice(truncated);
    assert!(
        result.is_err(),
        "decoding truncated bytes must return an error, not silently succeed"
    );
}