oxicode 0.2.1

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
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
//! Advanced tests for OxiCode serialization of enums with mixed variant types.
//!
//! Covers 22 distinct scenarios testing unit, tuple, and struct variants within
//! the same enum, including roundtrips, wire-format properties, config variants,
//! collections, nesting, and discriminant verification.

#![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, Decode, Encode,
};

// ---------------------------------------------------------------------------
// Shared enum definitions
// ---------------------------------------------------------------------------

#[derive(Debug, PartialEq, Encode, Decode)]
enum Event {
    Start,
    Stop,
    Data(Vec<u8>),
    Named { id: u32, label: String },
}

#[derive(Debug, PartialEq, Encode, Decode)]
enum Shape {
    Circle { radius: f64 },
    Rectangle { w: f64, h: f64 },
    Point,
}

#[derive(Debug, PartialEq, Encode, Decode)]
enum Command {
    Quit,
    Move { x: i32, y: i32 },
    Write(String),
    ChangeColor(u8, u8, u8),
}

#[derive(Debug, PartialEq, Encode, Decode)]
enum Status {
    Ok,
    Err(String),
    Pending { reason: String, retry_in: u32 },
}

// Used for the nested enum test (test 19).
#[derive(Debug, PartialEq, Encode, Decode)]
enum Inner {
    Leaf,
    Value(u32),
}

#[derive(Debug, PartialEq, Encode, Decode)]
enum Container {
    Empty,
    Wrapped(Inner),
    Tagged { tag: String, inner: Inner },
}

// ---------------------------------------------------------------------------
// Test 1: Event::Start roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_event_start_roundtrip() {
    let original = Event::Start;
    let encoded = encode_to_vec(&original).expect("encode Event::Start");
    let (decoded, _): (Event, usize) = decode_from_slice(&encoded).expect("decode Event::Start");
    assert_eq!(original, decoded);
}

// ---------------------------------------------------------------------------
// Test 2: Event::Stop roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_event_stop_roundtrip() {
    let original = Event::Stop;
    let encoded = encode_to_vec(&original).expect("encode Event::Stop");
    let (decoded, _): (Event, usize) = decode_from_slice(&encoded).expect("decode Event::Stop");
    assert_eq!(original, decoded);
}

// ---------------------------------------------------------------------------
// Test 3: Event::Data(vec![1,2,3]) roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_event_data_roundtrip() {
    let original = Event::Data(vec![1, 2, 3]);
    let encoded = encode_to_vec(&original).expect("encode Event::Data");
    let (decoded, _): (Event, usize) = decode_from_slice(&encoded).expect("decode Event::Data");
    assert_eq!(original, decoded);
}

// ---------------------------------------------------------------------------
// Test 4: Event::Named { id: 42, label: "hello".into() } roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_event_named_roundtrip() {
    let original = Event::Named {
        id: 42,
        label: "hello".to_string(),
    };
    let encoded = encode_to_vec(&original).expect("encode Event::Named");
    let (decoded, _): (Event, usize) = decode_from_slice(&encoded).expect("decode Event::Named");
    assert_eq!(original, decoded);
}

// ---------------------------------------------------------------------------
// Test 5: Shape::Circle roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_shape_circle_roundtrip() {
    let original = Shape::Circle {
        radius: std::f64::consts::PI,
    };
    let encoded = encode_to_vec(&original).expect("encode Shape::Circle");
    let (decoded, _): (Shape, usize) = decode_from_slice(&encoded).expect("decode Shape::Circle");
    assert_eq!(original, decoded);
}

// ---------------------------------------------------------------------------
// Test 6: Shape::Rectangle roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_shape_rectangle_roundtrip() {
    let original = Shape::Rectangle { w: 10.0, h: 5.5 };
    let encoded = encode_to_vec(&original).expect("encode Shape::Rectangle");
    let (decoded, _): (Shape, usize) =
        decode_from_slice(&encoded).expect("decode Shape::Rectangle");
    assert_eq!(original, decoded);
}

// ---------------------------------------------------------------------------
// Test 7: Shape::Point roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_shape_point_roundtrip() {
    let original = Shape::Point;
    let encoded = encode_to_vec(&original).expect("encode Shape::Point");
    let (decoded, _): (Shape, usize) = decode_from_slice(&encoded).expect("decode Shape::Point");
    assert_eq!(original, decoded);
}

// ---------------------------------------------------------------------------
// Test 8: Wire bytes differ for different variants (assert_ne!)
// ---------------------------------------------------------------------------

#[test]
fn test_different_variants_have_different_wire_bytes() {
    let start_bytes = encode_to_vec(&Event::Start).expect("encode Event::Start");
    let stop_bytes = encode_to_vec(&Event::Stop).expect("encode Event::Stop");
    let data_bytes = encode_to_vec(&Event::Data(vec![])).expect("encode Event::Data");
    let named_bytes = encode_to_vec(&Event::Named {
        id: 0,
        label: String::new(),
    })
    .expect("encode Event::Named");

    assert_ne!(
        start_bytes, stop_bytes,
        "Start and Stop must have different wire bytes"
    );
    assert_ne!(
        start_bytes, data_bytes,
        "Start and Data must have different wire bytes"
    );
    assert_ne!(
        start_bytes, named_bytes,
        "Start and Named must have different wire bytes"
    );
    assert_ne!(
        stop_bytes, data_bytes,
        "Stop and Data must have different wire bytes"
    );
}

// ---------------------------------------------------------------------------
// Test 9: Consumed == encoded.len() for each variant
// ---------------------------------------------------------------------------

#[test]
fn test_consumed_equals_encoded_len_for_all_event_variants() {
    let variants = [
        Event::Start,
        Event::Stop,
        Event::Data(vec![0xFF, 0x00]),
        Event::Named {
            id: 7,
            label: "test".to_string(),
        },
    ];

    for variant in &variants {
        let encoded = encode_to_vec(variant).expect("encode Event variant");
        let (_, consumed): (Event, usize) =
            decode_from_slice(&encoded).expect("decode Event variant");
        assert_eq!(
            consumed,
            encoded.len(),
            "all encoded bytes must be consumed for {:?}",
            variant
        );
    }
}

// ---------------------------------------------------------------------------
// Test 10: Vec<Event> with all 4 variants roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_vec_event_all_variants_roundtrip() {
    let original = vec![
        Event::Start,
        Event::Stop,
        Event::Data(vec![10, 20, 30]),
        Event::Named {
            id: 99,
            label: "batch".to_string(),
        },
    ];
    let encoded = encode_to_vec(&original).expect("encode Vec<Event>");
    let (decoded, consumed): (Vec<Event>, usize) =
        decode_from_slice(&encoded).expect("decode Vec<Event>");
    assert_eq!(original, decoded);
    assert_eq!(consumed, encoded.len());
}

// ---------------------------------------------------------------------------
// Test 11: Option<Event> Some(Data) roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_option_event_some_data_roundtrip() {
    let original: Option<Event> = Some(Event::Data(vec![0xAB, 0xCD, 0xEF]));
    let encoded = encode_to_vec(&original).expect("encode Option<Event> Some(Data)");
    let (decoded, consumed): (Option<Event>, usize) =
        decode_from_slice(&encoded).expect("decode Option<Event> Some(Data)");
    assert_eq!(original, decoded);
    assert_eq!(consumed, encoded.len());
}

// ---------------------------------------------------------------------------
// Test 12: Option<Event> None roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_option_event_none_roundtrip() {
    let original: Option<Event> = None;
    let encoded = encode_to_vec(&original).expect("encode Option<Event> None");
    let (decoded, consumed): (Option<Event>, usize) =
        decode_from_slice(&encoded).expect("decode Option<Event> None");
    assert_eq!(original, decoded);
    assert_eq!(consumed, encoded.len());
}

// ---------------------------------------------------------------------------
// Test 13: Fixed-int config with Event::Named { id: 1, label: "x".into() }
// ---------------------------------------------------------------------------

#[test]
fn test_fixed_int_config_event_named_roundtrip() {
    let original = Event::Named {
        id: 1,
        label: "x".to_string(),
    };
    let cfg = config::legacy();
    let encoded = encode_to_vec_with_config(&original, cfg).expect("legacy encode Event::Named");
    let (decoded, consumed): (Event, usize) =
        decode_from_slice_with_config(&encoded, cfg).expect("legacy decode Event::Named");
    assert_eq!(original, decoded);
    assert_eq!(consumed, encoded.len());
}

// ---------------------------------------------------------------------------
// Test 14: Big-endian config with Shape::Circle { radius: PI }
// ---------------------------------------------------------------------------

#[test]
fn test_big_endian_config_shape_circle_roundtrip() {
    let original = Shape::Circle {
        radius: std::f64::consts::PI,
    };
    let cfg = config::standard().with_big_endian();
    let encoded =
        encode_to_vec_with_config(&original, cfg).expect("big-endian encode Shape::Circle");
    let (decoded, consumed): (Shape, usize) =
        decode_from_slice_with_config(&encoded, cfg).expect("big-endian decode Shape::Circle");
    assert_eq!(original, decoded);
    assert_eq!(consumed, encoded.len());
}

// ---------------------------------------------------------------------------
// Test 15: Command::Quit roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_command_quit_roundtrip() {
    let original = Command::Quit;
    let encoded = encode_to_vec(&original).expect("encode Command::Quit");
    let (decoded, _): (Command, usize) = decode_from_slice(&encoded).expect("decode Command::Quit");
    assert_eq!(original, decoded);
}

// ---------------------------------------------------------------------------
// Test 16: Command::Move roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_command_move_roundtrip() {
    let original = Command::Move { x: -5, y: 100 };
    let encoded = encode_to_vec(&original).expect("encode Command::Move");
    let (decoded, _): (Command, usize) = decode_from_slice(&encoded).expect("decode Command::Move");
    assert_eq!(original, decoded);
}

// ---------------------------------------------------------------------------
// Test 17: Command::Write roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_command_write_roundtrip() {
    let original = Command::Write("hello world".to_string());
    let encoded = encode_to_vec(&original).expect("encode Command::Write");
    let (decoded, _): (Command, usize) =
        decode_from_slice(&encoded).expect("decode Command::Write");
    assert_eq!(original, decoded);
}

// ---------------------------------------------------------------------------
// Test 18: Command::ChangeColor roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_command_change_color_roundtrip() {
    let original = Command::ChangeColor(255, 128, 0);
    let encoded = encode_to_vec(&original).expect("encode Command::ChangeColor");
    let (decoded, _): (Command, usize) =
        decode_from_slice(&encoded).expect("decode Command::ChangeColor");
    assert_eq!(original, decoded);
}

// ---------------------------------------------------------------------------
// Test 19: Nested: enum containing another enum as a field
// ---------------------------------------------------------------------------

#[test]
fn test_nested_enum_as_field_roundtrip() {
    let cases = [
        Container::Empty,
        Container::Wrapped(Inner::Leaf),
        Container::Wrapped(Inner::Value(42)),
        Container::Tagged {
            tag: "important".to_string(),
            inner: Inner::Value(99),
        },
    ];
    for original in &cases {
        let encoded = encode_to_vec(original).expect("encode Container variant");
        let (decoded, consumed): (Container, usize) =
            decode_from_slice(&encoded).expect("decode Container variant");
        assert_eq!(original, &decoded);
        assert_eq!(consumed, encoded.len());
    }
}

// ---------------------------------------------------------------------------
// Test 20: Vec<Command> with all variants roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_vec_command_all_variants_roundtrip() {
    let original = vec![
        Command::Quit,
        Command::Move { x: 10, y: -3 },
        Command::Write("oxicode".to_string()),
        Command::ChangeColor(0, 255, 0),
        Command::Move { x: 0, y: 0 },
        Command::Write(String::new()),
    ];
    let encoded = encode_to_vec(&original).expect("encode Vec<Command>");
    let (decoded, consumed): (Vec<Command>, usize) =
        decode_from_slice(&encoded).expect("decode Vec<Command>");
    assert_eq!(original, decoded);
    assert_eq!(consumed, encoded.len());
}

// ---------------------------------------------------------------------------
// Test 21: Discriminant byte check: first variant has discriminant 0
// ---------------------------------------------------------------------------

#[test]
fn test_first_variant_has_discriminant_zero() {
    // For unit variants, the entire encoding is the discriminant (varint).
    // Discriminant 0 always encodes as a single byte 0x00.
    let quit_bytes = encode_to_vec(&Command::Quit).expect("encode Command::Quit");
    assert_eq!(
        quit_bytes.len(),
        1,
        "Command::Quit (first variant) must encode to exactly 1 byte"
    );
    assert_eq!(quit_bytes[0], 0u8, "Command::Quit discriminant must be 0");

    let start_bytes = encode_to_vec(&Event::Start).expect("encode Event::Start");
    assert_eq!(
        start_bytes.len(),
        1,
        "Event::Start (first variant) must encode to exactly 1 byte"
    );
    assert_eq!(start_bytes[0], 0u8, "Event::Start discriminant must be 0");

    let circle_bytes = encode_to_vec(&Shape::Circle { radius: 1.0 }).expect("encode Shape::Circle");
    assert_eq!(
        circle_bytes[0], 0u8,
        "Shape::Circle (first variant) discriminant must be 0"
    );
}

// ---------------------------------------------------------------------------
// Test 22: Status enum — all 3 variants roundtrip
// ---------------------------------------------------------------------------

#[test]
fn test_status_all_variants_roundtrip() {
    let cases = [
        Status::Ok,
        Status::Err("something went wrong".to_string()),
        Status::Pending {
            reason: "waiting for upstream".to_string(),
            retry_in: 30,
        },
    ];

    for original in &cases {
        let encoded = encode_to_vec(original).expect("encode Status variant");
        let (decoded, consumed): (Status, usize) =
            decode_from_slice(&encoded).expect("decode Status variant");
        assert_eq!(original, &decoded);
        assert_eq!(
            consumed,
            encoded.len(),
            "all bytes must be consumed for {:?}",
            original
        );
    }
}