fbe 0.2.0

Fast Binary Encoding (FBE) for Rust - High-performance, zero-copy binary serialization with 100% C++ FBE parity and binary compatibility
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

/*!
 * FBE Default Values Support for Rust
 */

use crate::buffer::{ReadBuffer, WriteBuffer};

// Numeric defaults
#[derive(Debug, Clone, PartialEq)]
pub struct Config {
    pub timeout: i32,
    pub retries: i32,
    pub threshold: f64,
    pub ratio: f32,
}

impl Default for Config {
    fn default() -> Self {
        Self {
            timeout: 30,     // Schema default
            retries: 3,      // Schema default
            threshold: 0.95, // Schema default
            ratio: 1.5,      // Schema default
        }
    }
}

impl Config {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn serialize(&self, buffer: &mut WriteBuffer) -> usize {
        let mut offset = 0;
        buffer.write_i32(offset, self.timeout);
        offset += 4;
        buffer.write_i32(offset, self.retries);
        offset += 4;
        buffer.write_f64(offset, self.threshold);
        offset += 8;
        buffer.write_f32(offset, self.ratio);
        offset += 4;
        buffer.set_size(offset);
        offset
    }

    pub fn deserialize(buffer: &ReadBuffer) -> Self {
        let mut offset = 0;
        let timeout = buffer.read_i32(offset);
        offset += 4;
        let retries = buffer.read_i32(offset);
        offset += 4;
        let threshold = buffer.read_f64(offset);
        offset += 8;
        let ratio = buffer.read_f32(offset);
        Self {
            timeout,
            retries,
            threshold,
            ratio,
        }
    }
}

// String and boolean defaults
#[derive(Debug, Clone, PartialEq)]
pub struct Settings {
    pub enabled: bool,
    pub debug: bool,
    pub name: String,
    pub path: String,
}

impl Default for Settings {
    fn default() -> Self {
        Self {
            enabled: true,                   // Schema default
            debug: false,                    // Schema default
            name: "DefaultName".to_string(), // Schema default
            path: "/var/log".to_string(),    // Schema default
        }
    }
}

impl Settings {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn serialize(&self, buffer: &mut WriteBuffer) -> usize {
        let mut offset = 0;
        buffer.write_bool(offset, self.enabled);
        offset += 1;
        buffer.write_bool(offset, self.debug);
        offset += 1;
        buffer.write_string(offset, &self.name);
        offset += 4 + self.name.len();
        buffer.write_string(offset, &self.path);
        offset += 4 + self.path.len();
        buffer.set_size(offset);
        offset
    }

    pub fn deserialize(buffer: &ReadBuffer) -> Self {
        let mut offset = 0;
        let enabled = buffer.read_bool(offset);
        offset += 1;
        let debug = buffer.read_bool(offset);
        offset += 1;
        let name = buffer.read_string(offset);
        offset += 4 + name.len();
        let path = buffer.read_string(offset);
        Self {
            enabled,
            debug,
            name,
            path,
        }
    }
}

// Mixed defaults (some with, some without)
#[derive(Debug, Clone, PartialEq)]
pub struct Order {
    pub id: i32,
    pub symbol: String,
    pub price: f64,
    pub volume: f64,
    pub tp: f64,
    pub sl: f64,
}

impl Default for Order {
    fn default() -> Self {
        Self {
            id: 0,                 // Type default (no schema default)
            symbol: String::new(), // Type default (no schema default)
            price: 0.0,            // Schema default
            volume: 0.0,           // Schema default
            tp: 10.0,              // Schema default
            sl: -10.0,             // Schema default (negative)
        }
    }
}

impl Order {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn serialize(&self, buffer: &mut WriteBuffer) -> usize {
        let mut offset = 0;
        buffer.write_i32(offset, self.id);
        offset += 4;
        buffer.write_string(offset, &self.symbol);
        offset += 4 + self.symbol.len();
        buffer.write_f64(offset, self.price);
        offset += 8;
        buffer.write_f64(offset, self.volume);
        offset += 8;
        buffer.write_f64(offset, self.tp);
        offset += 8;
        buffer.write_f64(offset, self.sl);
        offset += 8;
        buffer.set_size(offset);
        offset
    }

    pub fn deserialize(buffer: &ReadBuffer) -> Self {
        let mut offset = 0;
        let id = buffer.read_i32(offset);
        offset += 4;
        let symbol = buffer.read_string(offset);
        offset += 4 + symbol.len();
        let price = buffer.read_f64(offset);
        offset += 8;
        let volume = buffer.read_f64(offset);
        offset += 8;
        let tp = buffer.read_f64(offset);
        offset += 8;
        let sl = buffer.read_f64(offset);
        Self {
            id,
            symbol,
            price,
            volume,
            tp,
            sl,
        }
    }
}

// Optional fields with defaults
#[derive(Debug, Clone, PartialEq)]
pub struct OptionalFields {
    pub count: Option<i32>,
    pub text: Option<String>,
    pub flag: Option<bool>,
    pub value: Option<f64>,
}

impl Default for OptionalFields {
    fn default() -> Self {
        Self {
            count: None,                       // Schema default (null)
            text: Some("Default".to_string()), // Schema default
            flag: Some(true),                  // Schema default
            value: None,                       // Type default (no schema default)
        }
    }
}

impl OptionalFields {
    pub fn new() -> Self {
        Self::default()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_config_numeric_defaults() {
        let config = Config::new();
        assert_eq!(config.timeout, 30);
        assert_eq!(config.retries, 3);
        assert!((config.threshold - 0.95).abs() < 0.001);
        assert!((config.ratio - 1.5).abs() < 0.001);
    }

    #[test]
    fn test_settings_string_bool_defaults() {
        let settings = Settings::new();
        assert_eq!(settings.enabled, true);
        assert_eq!(settings.debug, false);
        assert_eq!(settings.name, "DefaultName");
        assert_eq!(settings.path, "/var/log");
    }

    #[test]
    fn test_order_mixed_defaults() {
        let order = Order::new();
        assert_eq!(order.id, 0);
        assert_eq!(order.symbol, "");
        assert_eq!(order.price, 0.0);
        assert_eq!(order.volume, 0.0);
        assert_eq!(order.tp, 10.0);
        assert_eq!(order.sl, -10.0);
    }

    #[test]
    fn test_optional_fields_defaults() {
        let opt = OptionalFields::new();
        assert_eq!(opt.count, None);
        assert_eq!(opt.text, Some("Default".to_string()));
        assert_eq!(opt.flag, Some(true));
        assert_eq!(opt.value, None);
    }

    #[test]
    fn test_serialization_with_defaults() {
        let config = Config::new();
        let mut buffer = WriteBuffer::new();
        buffer.reserve(100);
        let size = config.serialize(&mut buffer);
        assert_eq!(size, 20); // 4 + 4 + 8 + 4

        let mut read_buffer = ReadBuffer::new();
        read_buffer.attach_buffer(buffer.data(), 0, buffer.data().len());
        let config2 = Config::deserialize(&read_buffer);

        assert_eq!(config, config2);
    }

    #[test]
    fn test_modify_defaults() {
        let mut order = Order::new();
        assert_eq!(order.tp, 10.0);
        assert_eq!(order.sl, -10.0);

        order.tp = 20.0;
        order.sl = -20.0;

        assert_eq!(order.tp, 20.0);
        assert_eq!(order.sl, -20.0);
    }
}