ngdb 2.2.2

A high-performance, thread-safe RocksDB wrapper
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

//! Serialization layer for NGDB
//!
//! This module provides the serialization abstraction layer that allows
//! pluggable codecs for encoding/decoding values.

use crate::{Error, Result};
use borsh::{BorshDeserialize, BorshSerialize};

/// Trait for encoding and decoding values to/from bytes.
///
/// This abstraction allows for different serialization formats to be used
/// with NGDB, though Borsh is the default and recommended choice for
/// performance and compatibility.
pub trait Codec: Send + Sync + 'static {
    /// Serialize a value to bytes
    fn encode<T: BorshSerialize>(&self, value: &T) -> Result<Vec<u8>>;

    /// Deserialize bytes to a value
    fn decode<T: BorshDeserialize>(&self, bytes: &[u8]) -> Result<T>;
}

/// Borsh-based codec implementation (default)
///
/// Borsh is a compact, fast binary serialization format that works
/// excellently for database storage.
///
/// Note: This struct is named `BincodeCodec` for backward compatibility,
/// but it uses Borsh serialization internally.
#[derive(Debug, Clone, Copy, Default)]
pub struct BincodeCodec;

impl BincodeCodec {
    /// Create a new BincodeCodec instance (uses Borsh serialization)
    pub fn new() -> Self {
        Self
    }
}

impl Codec for BincodeCodec {
    fn encode<T: BorshSerialize>(&self, value: &T) -> Result<Vec<u8>> {
        borsh::to_vec(value)
            .map_err(|e| Error::Serialization(format!("Failed to serialize value: {}", e)))
    }

    fn decode<T: BorshDeserialize>(&self, bytes: &[u8]) -> Result<T> {
        borsh::from_slice(bytes)
            .map_err(|e| Error::Deserialization(format!("Failed to deserialize value: {}", e)))
    }
}

/// Helper functions for direct serialization/deserialization
pub mod helpers {
    use super::*;

    /// Serialize a value using borsh
    #[inline]
    pub fn serialize<T: BorshSerialize>(value: &T) -> Result<Vec<u8>> {
        borsh::to_vec(value)
            .map_err(|e| Error::Serialization(format!("Serialization failed: {}", e)))
    }

    /// Deserialize a value using borsh
    #[inline]
    pub fn deserialize<T: BorshDeserialize>(bytes: &[u8]) -> Result<T> {
        borsh::from_slice(bytes)
            .map_err(|e| Error::Deserialization(format!("Deserialization failed: {}", e)))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use borsh::{BorshDeserialize, BorshSerialize};

    #[derive(Debug, PartialEq, BorshSerialize, BorshDeserialize)]
    struct TestStruct {
        id: u64,
        name: String,
        tags: Vec<String>,
    }

    #[test]
    fn test_bincode_codec() {
        let codec = BincodeCodec::new();

        let original = TestStruct {
            id: 123,
            name: "test".to_string(),
            tags: vec!["tag1".to_string(), "tag2".to_string()],
        };

        let encoded = codec.encode(&original).unwrap();
        let decoded: TestStruct = codec.decode(&encoded).unwrap();

        assert_eq!(original, decoded);
    }

    #[test]
    fn test_codec_with_primitives() {
        let codec = BincodeCodec::new();

        let num: u64 = 42;
        let encoded = codec.encode(&num).unwrap();
        let decoded: u64 = codec.decode(&encoded).unwrap();
        assert_eq!(num, decoded);

        let text = "Hello, NGDB!".to_string();
        let encoded = codec.encode(&text).unwrap();
        let decoded: String = codec.decode(&encoded).unwrap();
        assert_eq!(text, decoded);
    }

    #[test]
    fn test_helpers() {
        let original = vec![1u64, 2, 3, 4, 5];
        let serialized = helpers::serialize(&original).unwrap();
        let deserialized: Vec<u64> = helpers::deserialize(&serialized).unwrap();
        assert_eq!(original, deserialized);
    }
}