bebytes 3.0.2

A Rust library for serialization and deserialization of network structs.
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

//! Tests to verify the derive macro actually generates the expected code
//! This addresses the critical gap where derive_be_bytes could return Default::default()

use bebytes::BeBytes;

#[test]
fn test_derive_generates_trait_impl() {
    // This struct should have BeBytes trait methods after derive
    #[derive(BeBytes, Debug, PartialEq)]
    struct TestStruct {
        field1: u32,
        field2: u16,
    }

    // Verify the trait is implemented by calling its methods
    let test = TestStruct {
        field1: 0x12345678,
        field2: 0xABCD,
    };

    // These method calls prove the derive macro generated code
    let _size = TestStruct::field_size();
    let be_bytes = test.to_be_bytes();
    let le_bytes = test.to_le_bytes();

    // Verify the methods actually work
    assert_eq!(TestStruct::field_size(), 6); // 4 + 2 bytes
    assert_eq!(be_bytes.len(), 6);
    assert_eq!(le_bytes.len(), 6);

    // Verify parsing works
    let (parsed_be, consumed_be) = TestStruct::try_from_be_bytes(&be_bytes).unwrap();
    assert_eq!(parsed_be, test);
    assert_eq!(consumed_be, 6);

    let (parsed_le, consumed_le) = TestStruct::try_from_le_bytes(&le_bytes).unwrap();
    assert_eq!(parsed_le, test);
    assert_eq!(consumed_le, 6);
}

#[test]
fn test_derive_with_bit_fields() {
    #[derive(BeBytes, Debug, PartialEq)]
    struct BitFieldStruct {
        #[bits(4)]
        nibble: u8,
        #[bits(12)]
        twelve_bits: u16,
        regular: u32,
    }

    let test = BitFieldStruct {
        nibble: 0xF,
        twelve_bits: 0xFFF,
        regular: 0xDEADBEEF,
    };

    // Verify methods exist and work
    assert_eq!(BitFieldStruct::field_size(), 6); // 2 + 4 bytes
    let bytes = test.to_be_bytes();
    assert_eq!(bytes.len(), 6);

    let (parsed, _) = BitFieldStruct::try_from_be_bytes(&bytes).unwrap();
    assert_eq!(parsed, test);
}

#[test]
fn test_derive_with_enums() {
    #[derive(BeBytes, Debug, PartialEq, Copy, Clone)]
    enum TestEnum {
        First = 1,
        Second = 2,
        Third = 3,
    }

    // Verify enum derive works
    let val = TestEnum::Second;
    let bytes = val.to_be_bytes();
    assert_eq!(bytes, vec![2]);

    let (parsed, _) = TestEnum::try_from_be_bytes(&bytes).unwrap();
    assert_eq!(parsed, TestEnum::Second);
}

#[test]
fn test_derive_with_vectors() {
    #[derive(BeBytes, Debug, PartialEq)]
    struct VectorStruct {
        len: u16,
        #[FromField(len)]
        data: Vec<u8>,
    }

    let test = VectorStruct {
        len: 3,
        data: vec![1, 2, 3],
    };

    let bytes = test.to_be_bytes();
    assert_eq!(bytes.len(), 5); // 2 + 3

    let (parsed, _) = VectorStruct::try_from_be_bytes(&bytes).unwrap();
    assert_eq!(parsed, test);
}

#[test]
fn test_derive_generates_new_constructor() {
    #[derive(BeBytes, Debug, PartialEq)]
    struct ConstructorTest {
        a: u32,
        b: u16,
        c: u8,
    }

    // The derive macro should generate a new() constructor
    let test = ConstructorTest::new(0x12345678, 0xABCD, 0xEF);
    assert_eq!(test.a, 0x12345678);
    assert_eq!(test.b, 0xABCD);
    assert_eq!(test.c, 0xEF);
}

#[test]
fn test_macro_generates_all_required_methods() {
    #[derive(BeBytes)]
    struct MethodTest {
        value: u32,
    }

    // Verify all required trait methods exist by using them
    let test = MethodTest { value: 42 };

    // Static method
    let size = MethodTest::field_size();
    assert!(size > 0);

    // Instance methods for serialization
    let be_bytes = test.to_be_bytes();
    let le_bytes = test.to_le_bytes();
    assert!(!be_bytes.is_empty());
    assert!(!le_bytes.is_empty());

    // Static methods for deserialization
    let be_result = MethodTest::try_from_be_bytes(&be_bytes);
    let le_result = MethodTest::try_from_le_bytes(&le_bytes);
    assert!(be_result.is_ok());
    assert!(le_result.is_ok());
}