packable 0.11.0

A crate for packing and unpacking binary representations.
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

// Copyright 2023 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

mod common;

use packable::{
    bounded::{
        BoundedU16, BoundedU32, BoundedU64, BoundedU8, InvalidBoundedU16, InvalidBoundedU32, InvalidBoundedU64,
        InvalidBoundedU8,
    },
    error::UnpackError,
    PackableExt,
};

macro_rules! impl_bounds_test_for_bounded_integer {
    ($name:ident, $wrapper:ty, $error:ident, $wrapped:ty) => {
        #[test]
        fn $name() {
            let valid = <$wrapper>::MIN;

            let wrapper = <$wrapper>::try_from(valid);
            assert!(wrapper.is_ok());

            let wrapped: $wrapped = wrapper.unwrap().into();
            assert_eq!(wrapped, valid);

            let invalid = <$wrapper>::MAX + 1;
            assert!(matches!(
                <$wrapper>::try_from(invalid),
                Err($error(val))
                    if val == invalid,
            ));
        }
    };
}

macro_rules! impl_packable_test_for_bounded_integer {
    ($packable_valid_name:ident, $packable_invalid_name:ident, $wrapper:ty, $error:ident, $wrapped:ty) => {
        #[test]
        fn $packable_valid_name() {
            let valid = <$wrapper>::MIN;

            assert_eq!(
                common::generic_test(&<$wrapper>::try_from(valid).unwrap())
                    .0
                    .len(),
                core::mem::size_of::<$wrapped>()
            );
        }

        #[test]
        fn $packable_invalid_name() {
            let bytes = vec![0u8; core::mem::size_of::<$wrapped>()];
            let unpacked = <$wrapper>::unpack_bytes_verified(&bytes, &());

            assert!(matches!(unpacked, Err(UnpackError::Packable($error(0)))))
        }
    };
}

impl_bounds_test_for_bounded_integer!(bounded_u8, BoundedU8<1, 8>, InvalidBoundedU8, u8);
impl_bounds_test_for_bounded_integer!(bounded_u16, BoundedU16<1, 8>, InvalidBoundedU16, u16);
impl_bounds_test_for_bounded_integer!(bounded_u32, BoundedU32<1, 8>, InvalidBoundedU32, u32);
impl_bounds_test_for_bounded_integer!(bounded_u64, BoundedU64<1, 8>, InvalidBoundedU64, u64);

impl_packable_test_for_bounded_integer!(packable_bounded_u8, packable_bounded_u8_invalid, BoundedU8<1, 8>, InvalidBoundedU8, u8);
impl_packable_test_for_bounded_integer!(packable_bounded_u16, packable_bounded_u16_invalid, BoundedU16<1, 8>, InvalidBoundedU16, u16);
impl_packable_test_for_bounded_integer!(packable_bounded_u32, packable_bounded_u32_invalid, BoundedU32<1, 8>, InvalidBoundedU32, u32);
impl_packable_test_for_bounded_integer!(packable_bounded_u64, packable_bounded_u64_invalid, BoundedU64<1, 8>, InvalidBoundedU64, u64);