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
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
#![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::{decode_from_slice, encode_to_vec, Decode, Encode};
use proptest::prelude::*;

#[derive(Debug, PartialEq, Clone, Encode, Decode)]
struct WeatherStation {
    id: u32,
    lat: i32,
    lon: i32,
    elevation_m: i16,
}

#[derive(Debug, PartialEq, Clone, Encode, Decode)]
struct WeatherReading {
    station_id: u32,
    temp_c_x10: i32,
    humidity_pct: u8,
    pressure_hpa_x10: u32,
    wind_speed_ms_x10: u16,
}

#[derive(Debug, PartialEq, Clone, Encode, Decode)]
struct ForecastCell {
    grid_x: u16,
    grid_y: u16,
    precip_mm_x10: u32,
    cloud_cover_pct: u8,
}

#[derive(Debug, PartialEq, Clone, Encode, Decode)]
struct ClimateRecord {
    year: u16,
    month: u8,
    avg_temp_x10: i32,
    total_precip_x10: u32,
}

#[derive(Debug, PartialEq, Clone, Encode, Decode)]
enum WeatherEvent {
    Clear,
    Cloudy,
    Rain,
    Snow,
    Thunderstorm,
    Fog,
}

proptest! {
    #[test]
    fn test_weather_station_roundtrip(
        id in 0u32..=u32::MAX,
        lat in (-90_000_000i32..=90_000_000i32),
        lon in (-180_000_000i32..=180_000_000i32),
        elevation_m in i16::MIN..=i16::MAX,
    ) {
        let station = WeatherStation { id, lat, lon, elevation_m };
        let encoded = encode_to_vec(&station).expect("encode WeatherStation");
        let (decoded, _): (WeatherStation, usize) = decode_from_slice(&encoded).expect("decode WeatherStation");
        prop_assert_eq!(station, decoded);
    }

    #[test]
    fn test_weather_reading_roundtrip(
        station_id in 0u32..=u32::MAX,
        temp_c_x10 in (-600i32..=600i32),
        humidity_pct in 0u8..=100u8,
        pressure_hpa_x10 in 8000u32..=12000u32,
        wind_speed_ms_x10 in 0u16..=1000u16,
    ) {
        let reading = WeatherReading {
            station_id,
            temp_c_x10,
            humidity_pct,
            pressure_hpa_x10,
            wind_speed_ms_x10,
        };
        let encoded = encode_to_vec(&reading).expect("encode WeatherReading");
        let (decoded, _): (WeatherReading, usize) = decode_from_slice(&encoded).expect("decode WeatherReading");
        prop_assert_eq!(reading, decoded);
    }

    #[test]
    fn test_forecast_cell_roundtrip(
        grid_x in 0u16..=u16::MAX,
        grid_y in 0u16..=u16::MAX,
        precip_mm_x10 in 0u32..=50000u32,
        cloud_cover_pct in 0u8..=100u8,
    ) {
        let cell = ForecastCell { grid_x, grid_y, precip_mm_x10, cloud_cover_pct };
        let encoded = encode_to_vec(&cell).expect("encode ForecastCell");
        let (decoded, _): (ForecastCell, usize) = decode_from_slice(&encoded).expect("decode ForecastCell");
        prop_assert_eq!(cell, decoded);
    }

    #[test]
    fn test_climate_record_roundtrip(
        year in 1800u16..=2200u16,
        month in 1u8..=12u8,
        avg_temp_x10 in (-800i32..=600i32),
        total_precip_x10 in 0u32..=100000u32,
    ) {
        let record = ClimateRecord { year, month, avg_temp_x10, total_precip_x10 };
        let encoded = encode_to_vec(&record).expect("encode ClimateRecord");
        let (decoded, _): (ClimateRecord, usize) = decode_from_slice(&encoded).expect("decode ClimateRecord");
        prop_assert_eq!(record, decoded);
    }

    #[test]
    fn test_weather_event_roundtrip(event_idx in 0usize..6) {
        let events = [
            WeatherEvent::Clear,
            WeatherEvent::Cloudy,
            WeatherEvent::Rain,
            WeatherEvent::Snow,
            WeatherEvent::Thunderstorm,
            WeatherEvent::Fog,
        ];
        let event = events[event_idx].clone();
        let encoded = encode_to_vec(&event).expect("encode WeatherEvent");
        let (decoded, _): (WeatherEvent, usize) = decode_from_slice(&encoded).expect("decode WeatherEvent");
        prop_assert_eq!(event, decoded);
    }

    #[test]
    fn test_weather_station_deterministic_encoding(
        id in 0u32..=u32::MAX,
        lat in (-90_000_000i32..=90_000_000i32),
        lon in (-180_000_000i32..=180_000_000i32),
        elevation_m in i16::MIN..=i16::MAX,
    ) {
        let station = WeatherStation { id, lat, lon, elevation_m };
        let encoded1 = encode_to_vec(&station).expect("first encode WeatherStation");
        let encoded2 = encode_to_vec(&station).expect("second encode WeatherStation");
        prop_assert_eq!(encoded1, encoded2);
    }

    #[test]
    fn test_weather_reading_deterministic_encoding(
        station_id in 0u32..=u32::MAX,
        temp_c_x10 in (-600i32..=600i32),
        humidity_pct in 0u8..=100u8,
        pressure_hpa_x10 in 8000u32..=12000u32,
        wind_speed_ms_x10 in 0u16..=1000u16,
    ) {
        let reading = WeatherReading {
            station_id,
            temp_c_x10,
            humidity_pct,
            pressure_hpa_x10,
            wind_speed_ms_x10,
        };
        let encoded1 = encode_to_vec(&reading).expect("first encode WeatherReading");
        let encoded2 = encode_to_vec(&reading).expect("second encode WeatherReading");
        prop_assert_eq!(encoded1, encoded2);
    }

    #[test]
    fn test_weather_station_consumed_bytes(
        id in 0u32..=u32::MAX,
        lat in (-90_000_000i32..=90_000_000i32),
        lon in (-180_000_000i32..=180_000_000i32),
        elevation_m in i16::MIN..=i16::MAX,
    ) {
        let station = WeatherStation { id, lat, lon, elevation_m };
        let encoded = encode_to_vec(&station).expect("encode WeatherStation");
        let expected_len = encoded.len();
        let (_, consumed): (WeatherStation, usize) = decode_from_slice(&encoded).expect("decode WeatherStation");
        prop_assert_eq!(consumed, expected_len);
    }

    #[test]
    fn test_weather_reading_consumed_bytes(
        station_id in 0u32..=u32::MAX,
        temp_c_x10 in (-600i32..=600i32),
        humidity_pct in 0u8..=100u8,
        pressure_hpa_x10 in 8000u32..=12000u32,
        wind_speed_ms_x10 in 0u16..=1000u16,
    ) {
        let reading = WeatherReading {
            station_id,
            temp_c_x10,
            humidity_pct,
            pressure_hpa_x10,
            wind_speed_ms_x10,
        };
        let encoded = encode_to_vec(&reading).expect("encode WeatherReading");
        let expected_len = encoded.len();
        let (_, consumed): (WeatherReading, usize) = decode_from_slice(&encoded).expect("decode WeatherReading");
        prop_assert_eq!(consumed, expected_len);
    }

    #[test]
    fn test_forecast_cell_consumed_bytes(
        grid_x in 0u16..=u16::MAX,
        grid_y in 0u16..=u16::MAX,
        precip_mm_x10 in 0u32..=50000u32,
        cloud_cover_pct in 0u8..=100u8,
    ) {
        let cell = ForecastCell { grid_x, grid_y, precip_mm_x10, cloud_cover_pct };
        let encoded = encode_to_vec(&cell).expect("encode ForecastCell");
        let expected_len = encoded.len();
        let (_, consumed): (ForecastCell, usize) = decode_from_slice(&encoded).expect("decode ForecastCell");
        prop_assert_eq!(consumed, expected_len);
    }

    #[test]
    fn test_climate_record_consumed_bytes(
        year in 1800u16..=2200u16,
        month in 1u8..=12u8,
        avg_temp_x10 in (-800i32..=600i32),
        total_precip_x10 in 0u32..=100000u32,
    ) {
        let record = ClimateRecord { year, month, avg_temp_x10, total_precip_x10 };
        let encoded = encode_to_vec(&record).expect("encode ClimateRecord");
        let expected_len = encoded.len();
        let (_, consumed): (ClimateRecord, usize) = decode_from_slice(&encoded).expect("decode ClimateRecord");
        prop_assert_eq!(consumed, expected_len);
    }

    #[test]
    fn test_vec_weather_readings_roundtrip(
        readings in prop::collection::vec(
            (
                0u32..=9999u32,
                (-600i32..=600i32),
                0u8..=100u8,
                8000u32..=12000u32,
                0u16..=1000u16,
            ),
            0..=50,
        )
    ) {
        let readings_vec: Vec<WeatherReading> = readings
            .into_iter()
            .map(|(station_id, temp_c_x10, humidity_pct, pressure_hpa_x10, wind_speed_ms_x10)| {
                WeatherReading { station_id, temp_c_x10, humidity_pct, pressure_hpa_x10, wind_speed_ms_x10 }
            })
            .collect();
        let encoded = encode_to_vec(&readings_vec).expect("encode Vec<WeatherReading>");
        let (decoded, _): (Vec<WeatherReading>, usize) =
            decode_from_slice(&encoded).expect("decode Vec<WeatherReading>");
        prop_assert_eq!(readings_vec, decoded);
    }

    #[test]
    fn test_vec_forecast_cells_roundtrip(
        cells in prop::collection::vec(
            (0u16..=u16::MAX, 0u16..=u16::MAX, 0u32..=50000u32, 0u8..=100u8),
            0..=50,
        )
    ) {
        let cells_vec: Vec<ForecastCell> = cells
            .into_iter()
            .map(|(grid_x, grid_y, precip_mm_x10, cloud_cover_pct)| {
                ForecastCell { grid_x, grid_y, precip_mm_x10, cloud_cover_pct }
            })
            .collect();
        let encoded = encode_to_vec(&cells_vec).expect("encode Vec<ForecastCell>");
        let (decoded, _): (Vec<ForecastCell>, usize) =
            decode_from_slice(&encoded).expect("decode Vec<ForecastCell>");
        prop_assert_eq!(cells_vec, decoded);
    }

    #[test]
    fn test_option_weather_station_some_roundtrip(
        id in 0u32..=u32::MAX,
        lat in (-90_000_000i32..=90_000_000i32),
        lon in (-180_000_000i32..=180_000_000i32),
        elevation_m in i16::MIN..=i16::MAX,
    ) {
        let station = Some(WeatherStation { id, lat, lon, elevation_m });
        let encoded = encode_to_vec(&station).expect("encode Option<WeatherStation> Some");
        let (decoded, _): (Option<WeatherStation>, usize) =
            decode_from_slice(&encoded).expect("decode Option<WeatherStation> Some");
        prop_assert_eq!(station, decoded);
    }

    #[test]
    fn test_option_weather_station_none_roundtrip(_dummy in 0u8..=1u8) {
        let station: Option<WeatherStation> = None;
        let encoded = encode_to_vec(&station).expect("encode Option<WeatherStation> None");
        let (decoded, _): (Option<WeatherStation>, usize) =
            decode_from_slice(&encoded).expect("decode Option<WeatherStation> None");
        prop_assert_eq!(station, decoded);
    }

    #[test]
    fn test_option_climate_record_roundtrip(
        include in any::<bool>(),
        year in 1800u16..=2200u16,
        month in 1u8..=12u8,
        avg_temp_x10 in (-800i32..=600i32),
        total_precip_x10 in 0u32..=100000u32,
    ) {
        let record: Option<ClimateRecord> = if include {
            Some(ClimateRecord { year, month, avg_temp_x10, total_precip_x10 })
        } else {
            None
        };
        let encoded = encode_to_vec(&record).expect("encode Option<ClimateRecord>");
        let (decoded, _): (Option<ClimateRecord>, usize) =
            decode_from_slice(&encoded).expect("decode Option<ClimateRecord>");
        prop_assert_eq!(record, decoded);
    }

    #[test]
    fn test_large_collection_weather_stations(
        stations in prop::collection::vec(
            (
                0u32..=999999u32,
                (-90_000_000i32..=90_000_000i32),
                (-180_000_000i32..=180_000_000i32),
                i16::MIN..=i16::MAX,
            ),
            100..=200,
        )
    ) {
        let stations_vec: Vec<WeatherStation> = stations
            .into_iter()
            .map(|(id, lat, lon, elevation_m)| WeatherStation { id, lat, lon, elevation_m })
            .collect();
        let encoded = encode_to_vec(&stations_vec).expect("encode large Vec<WeatherStation>");
        let (decoded, consumed): (Vec<WeatherStation>, usize) =
            decode_from_slice(&encoded).expect("decode large Vec<WeatherStation>");
        prop_assert_eq!(&stations_vec, &decoded);
        prop_assert_eq!(consumed, encoded.len());
    }

    #[test]
    fn test_large_collection_climate_records(
        records in prop::collection::vec(
            (1800u16..=2200u16, 1u8..=12u8, (-800i32..=600i32), 0u32..=100000u32),
            100..=200,
        )
    ) {
        let records_vec: Vec<ClimateRecord> = records
            .into_iter()
            .map(|(year, month, avg_temp_x10, total_precip_x10)| {
                ClimateRecord { year, month, avg_temp_x10, total_precip_x10 }
            })
            .collect();
        let encoded = encode_to_vec(&records_vec).expect("encode large Vec<ClimateRecord>");
        let (decoded, consumed): (Vec<ClimateRecord>, usize) =
            decode_from_slice(&encoded).expect("decode large Vec<ClimateRecord>");
        prop_assert_eq!(&records_vec, &decoded);
        prop_assert_eq!(consumed, encoded.len());
    }

    #[test]
    fn test_weather_event_all_variants_consumed_bytes(event_idx in 0usize..6) {
        let events = [
            WeatherEvent::Clear,
            WeatherEvent::Cloudy,
            WeatherEvent::Rain,
            WeatherEvent::Snow,
            WeatherEvent::Thunderstorm,
            WeatherEvent::Fog,
        ];
        let event = events[event_idx].clone();
        let encoded = encode_to_vec(&event).expect("encode WeatherEvent for consumed bytes");
        let expected_len = encoded.len();
        let (_, consumed): (WeatherEvent, usize) =
            decode_from_slice(&encoded).expect("decode WeatherEvent for consumed bytes");
        prop_assert_eq!(consumed, expected_len);
    }

    #[test]
    fn test_climate_record_deterministic_encoding(
        year in 1800u16..=2200u16,
        month in 1u8..=12u8,
        avg_temp_x10 in (-800i32..=600i32),
        total_precip_x10 in 0u32..=100000u32,
    ) {
        let record = ClimateRecord { year, month, avg_temp_x10, total_precip_x10 };
        let encoded1 = encode_to_vec(&record).expect("first encode ClimateRecord");
        let encoded2 = encode_to_vec(&record).expect("second encode ClimateRecord");
        prop_assert_eq!(encoded1, encoded2);
    }

    #[test]
    fn test_forecast_cell_deterministic_encoding(
        grid_x in 0u16..=u16::MAX,
        grid_y in 0u16..=u16::MAX,
        precip_mm_x10 in 0u32..=50000u32,
        cloud_cover_pct in 0u8..=100u8,
    ) {
        let cell = ForecastCell { grid_x, grid_y, precip_mm_x10, cloud_cover_pct };
        let encoded1 = encode_to_vec(&cell).expect("first encode ForecastCell");
        let encoded2 = encode_to_vec(&cell).expect("second encode ForecastCell");
        prop_assert_eq!(encoded1, encoded2);
    }

    #[test]
    fn test_vec_weather_events_roundtrip(
        event_indices in prop::collection::vec(0usize..6, 0..=30)
    ) {
        let all_events = [
            WeatherEvent::Clear,
            WeatherEvent::Cloudy,
            WeatherEvent::Rain,
            WeatherEvent::Snow,
            WeatherEvent::Thunderstorm,
            WeatherEvent::Fog,
        ];
        let events_vec: Vec<WeatherEvent> = event_indices
            .iter()
            .map(|&i| all_events[i].clone())
            .collect();
        let encoded = encode_to_vec(&events_vec).expect("encode Vec<WeatherEvent>");
        let (decoded, consumed): (Vec<WeatherEvent>, usize) =
            decode_from_slice(&encoded).expect("decode Vec<WeatherEvent>");
        prop_assert_eq!(&events_vec, &decoded);
        prop_assert_eq!(consumed, encoded.len());
    }
}