oxide_core 0.4.0

Rust engine primitives for Oxide (store, snapshot streams, error model, optional persistence).
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

use crate::engine::{CoreResult, OxideError};

// Persistence encoding/decoding boundary.
//
// Why: persistence needs a stable, ergonomic API that can switch formats via
// feature flags without changing call sites.
//
// How: `encode`/`decode` are gated on `persistence-json` to choose JSON vs bincode
// while mapping errors into `OxideError::Persistence`.
#[cfg(not(feature = "persistence-json"))]
/// Serializes a value to bytes for persistence.
///
/// When `persistence-json` is disabled, this uses bincode.
///
/// # Errors
/// Returns [`OxideError::Persistence`] if serialization fails.
///
/// # Returns
/// A byte payload that can be written to disk and later passed to [`decode`].
pub fn encode<T>(value: &T) -> CoreResult<Vec<u8>>
where
    T: serde::Serialize,
{
    bincode::serialize(value).map_err(|e| OxideError::Persistence {
        message: e.to_string(),
    })
}

#[cfg(feature = "persistence-json")]
/// Serializes a value to bytes for persistence.
///
/// When `persistence-json` is enabled, this uses JSON.
///
/// # Errors
/// Returns [`OxideError::Persistence`] if serialization fails.
///
/// # Returns
/// A UTF-8 JSON byte payload that can be written to disk and later passed to [`decode`].
pub fn encode<T>(value: &T) -> CoreResult<Vec<u8>>
where
    T: serde::Serialize,
{
    serde_json::to_vec(value).map_err(|e| OxideError::Persistence {
        message: e.to_string(),
    })
}

#[cfg(not(feature = "persistence-json"))]
/// Deserializes a value from a persistence payload.
///
/// When `persistence-json` is disabled, this expects bincode bytes produced by [`encode`].
///
/// # Errors
/// Returns [`OxideError::Persistence`] if deserialization fails.
///
/// # Returns
/// The decoded value.
pub fn decode<T>(bytes: &[u8]) -> CoreResult<T>
where
    T: serde::de::DeserializeOwned,
{
    bincode::deserialize(bytes).map_err(|e| OxideError::Persistence {
        message: e.to_string(),
    })
}

#[cfg(feature = "persistence-json")]
/// Deserializes a value from a persistence payload.
///
/// When `persistence-json` is enabled, this expects UTF-8 JSON bytes produced by [`encode`].
///
/// # Errors
/// Returns [`OxideError::Persistence`] if deserialization fails.
///
/// # Returns
/// The decoded value.
pub fn decode<T>(bytes: &[u8]) -> CoreResult<T>
where
    T: serde::de::DeserializeOwned,
{
    serde_json::from_slice(bytes).map_err(|e| OxideError::Persistence {
        message: e.to_string(),
    })
}

#[cfg(feature = "persistence-json")]
/// Serializes a value to a JSON string.
///
/// This is a convenience API and is only available when `persistence-json` is enabled.
///
/// # Errors
/// Returns [`OxideError::Persistence`] if serialization fails.
///
/// # Returns
/// A UTF-8 JSON string.
pub fn encode_json<T>(value: &T) -> CoreResult<String>
where
    T: serde::Serialize,
{
    serde_json::to_string(value).map_err(|e| OxideError::Persistence {
        message: e.to_string(),
    })
}

#[cfg(feature = "persistence-json")]
/// Deserializes a value from a JSON string.
///
/// # Errors
/// Returns [`OxideError::Persistence`] if parsing fails.
///
/// # Returns
/// The decoded value.
pub fn decode_json<T>(value: &str) -> CoreResult<T>
where
    T: serde::de::DeserializeOwned,
{
    serde_json::from_str(value).map_err(|e| OxideError::Persistence {
        message: e.to_string(),
    })
}