osal-rs-serde 0.5.1

Serialization/Deserialization framework for osal-rs - extensible and reusable
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

/***************************************************************************
 *
 * osal-rs-serde - Binary Serialization Example
 * Copyright (C) 2026 Antonio Salsi <passy.linux@zresa.it>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, see <https://www.gnu.org/licenses/>.
 *
 ***************************************************************************/
use osal_rs_serde::{Serialize, Deserialize, to_bytes, from_bytes};

#[derive(Serialize, Deserialize, Debug, Clone, Copy, PartialEq)]
struct UserConfig {
    user_id: u32,
    role: u8,
    active: bool,
}

#[derive(Serialize, Deserialize, Debug, Clone, Copy, PartialEq)]
struct Config {
    version: u8,
    timezone: i16,
    users: [UserConfig; 3],  // Array of user configurations
    flags: u32,
}

fn main() {
    println!("=== Binary Serialization with to_bytes/from_bytes ===\n");
    
    // Create a configuration with array of users
    let config = Config {
        version: 1,
        timezone: 120,  // +2 hours
        users: [
            UserConfig { user_id: 1001, role: 1, active: true },
            UserConfig { user_id: 2002, role: 2, active: false },
            UserConfig { user_id: 3003, role: 3, active: true },
        ],
        flags: 0xFF00AA55,
    };

    println!("Original Config:");
    println!("  Version: {}", config.version);
    println!("  Timezone: {} minutes", config.timezone);
    println!("  Users:");
    for (i, user) in config.users.iter().enumerate() {
        println!("    [{}] ID: {}, Role: {}, Active: {}", 
                 i, user.user_id, user.role, user.active);
    }
    println!("  Flags: 0x{:08X}", config.flags);
    
    // Serialize to binary buffer
    let mut buffer = [0u8; 128];
    let len = to_bytes(&config, &mut buffer)
        .expect("Failed to serialize");
    
    println!("\n--- Binary Serialization ---");
    println!("Serialized {} bytes (little-endian format)", len);
    println!("Binary data (hex):");
    
    // Display binary data
    for chunk in buffer[..len].chunks(16) {
        print!("  ");
        for byte in chunk {
            print!("{:02X} ", byte);
        }
        println!();
    }
    
    // Calculate expected size
    // version: 1 byte
    // timezone: 2 bytes (i16)
    // users[0]: 4 (u32) + 1 (u8) + 1 (bool) = 6 bytes
    // users[1]: 6 bytes
    // users[2]: 6 bytes
    // flags: 4 bytes
    // Total: 1 + 2 + 18 + 4 = 25 bytes
    println!("\nExpected size: 25 bytes");
    println!("Actual size: {} bytes", len);
    assert_eq!(len, 25, "Size mismatch!");
    
    // Deserialize from binary
    println!("\n--- Binary Deserialization ---");
    let decoded: Config = from_bytes(&buffer[..len])
        .expect("Failed to deserialize");
    
    println!("Decoded Config:");
    println!("  Version: {}", decoded.version);
    println!("  Timezone: {} minutes", decoded.timezone);
    println!("  Users:");
    for (i, user) in decoded.users.iter().enumerate() {
        println!("    [{}] ID: {}, Role: {}, Active: {}", 
                 i, user.user_id, user.role, user.active);
    }
    println!("  Flags: 0x{:08X}", decoded.flags);
    
    // Verify data integrity
    println!("\n--- Verification ---");
    if decoded == config {
        println!("✓ Data integrity verified - perfect match!");
    } else {
        println!("✗ Data mismatch!");
    }
    
    assert_eq!(decoded.version, config.version);
    assert_eq!(decoded.timezone, config.timezone);
    assert_eq!(decoded.users, config.users);
    assert_eq!(decoded.flags, config.flags);
    
    println!("\n=== Binary Serialization Complete ===");
}