Skip to main content

reifydb_core/key/
system_version.rs

1// SPDX-License-Identifier: Apache-2.0
2// Copyright (c) 2025 ReifyDB
3
4use serde::{Deserialize, Serialize, de};
5
6use super::{EncodableKey, KeyKind};
7use crate::{
8	encoded::key::EncodedKey,
9	util::encoding::keycode::{deserializer::KeyDeserializer, serializer::KeySerializer},
10};
11
12#[derive(Debug, Clone, PartialEq)]
13pub struct SystemVersionKey {
14	pub version: SystemVersion,
15}
16
17#[repr(u8)]
18#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
19#[serde(try_from = "u8", into = "u8")]
20pub enum SystemVersion {
21	Storage = 0x01,
22}
23
24impl From<SystemVersion> for u8 {
25	fn from(version: SystemVersion) -> Self {
26		version as u8
27	}
28}
29impl TryFrom<u8> for SystemVersion {
30	type Error = de::value::Error;
31
32	fn try_from(value: u8) -> Result<Self, Self::Error> {
33		match value {
34			0x01 => Ok(Self::Storage),
35			_ => Err(de::Error::custom(format!("Invalid SystemVersion value: {value:#04x}"))),
36		}
37	}
38}
39
40impl SystemVersionKey {
41	pub fn encoded(version: SystemVersion) -> EncodedKey {
42		Self {
43			version,
44		}
45		.encode()
46	}
47}
48
49impl EncodableKey for SystemVersionKey {
50	const KIND: KeyKind = KeyKind::SystemVersion;
51
52	fn encode(&self) -> EncodedKey {
53		let mut serializer = KeySerializer::with_capacity(2);
54		serializer.extend_u8(Self::KIND as u8).extend_serialize(&self.version);
55		serializer.to_encoded_key()
56	}
57
58	fn decode(key: &EncodedKey) -> Option<Self>
59	where
60		Self: Sized,
61	{
62		let mut de = KeyDeserializer::from_bytes(key.as_slice());
63
64		let kind: KeyKind = de.read_u8().ok()?.try_into().ok()?;
65		if kind != Self::KIND {
66			return None;
67		}
68
69		let version_enum = de.read_u8().ok()?.try_into().ok()?;
70
71		Some(Self {
72			version: version_enum,
73		})
74	}
75}
76
77#[cfg(test)]
78pub mod tests {
79	use super::{EncodableKey, SystemVersion, SystemVersionKey};
80
81	#[test]
82	fn test_encode_decode_storage_version() {
83		let key = SystemVersionKey {
84			version: SystemVersion::Storage,
85		};
86		let encoded = key.encode();
87		let expected = vec![0xF5, 0xFE];
88		assert_eq!(encoded.as_slice(), expected);
89
90		let key = SystemVersionKey::decode(&encoded).unwrap();
91		assert_eq!(key.version, SystemVersion::Storage);
92	}
93}