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

//! FBE model trait for struct serialization

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

/// Base trait for FBE struct models
pub trait Model {
    /// The value type this model serializes
    type ValueType;

    /// Get FBE type ID
    fn fbe_type(&self) -> usize;

    /// Get FBE offset
    fn fbe_offset(&self) -> usize;

    /// Verify model
    fn verify(&self) -> bool;

    /// Get model size
    fn fbe_size(&self) -> usize;

    /// Serialize value and return serialized size
    fn serialize(&mut self, value: &Self::ValueType) -> usize;

    /// Deserialize value and return (value, deserialized size)
    fn deserialize(&self) -> (Self::ValueType, usize);

    /// Move to next position (for streaming)
    fn next(&mut self, size: usize);

    /// Get write buffer reference
    fn buffer_mut(&mut self) -> &mut WriteBuffer;

    /// Get read buffer reference
    fn buffer(&self) -> &ReadBuffer;
}