reifydb_core/key/
namespace.rs

1// Copyright (c) reifydb.com 2025
2// This file is licensed under the AGPL-3.0-or-later, see license.md file
3
4use super::{EncodableKey, KeyKind};
5use crate::{
6	EncodedKey, EncodedKeyRange,
7	interface::catalog::NamespaceId,
8	util::encoding::keycode::{KeyDeserializer, KeySerializer},
9};
10
11#[derive(Debug, Clone, PartialEq)]
12pub struct NamespaceKey {
13	pub namespace: NamespaceId,
14}
15
16const VERSION: u8 = 1;
17
18impl EncodableKey for NamespaceKey {
19	const KIND: KeyKind = KeyKind::Namespace;
20
21	fn encode(&self) -> EncodedKey {
22		let mut serializer = KeySerializer::with_capacity(10);
23		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(self.namespace);
24		serializer.to_encoded_key()
25	}
26
27	fn decode(key: &EncodedKey) -> Option<Self> {
28		let mut de = KeyDeserializer::from_bytes(key.as_slice());
29
30		let version = de.read_u8().ok()?;
31		if version != VERSION {
32			return None;
33		}
34
35		let kind: KeyKind = de.read_u8().ok()?.try_into().ok()?;
36		if kind != Self::KIND {
37			return None;
38		}
39
40		let namespace = de.read_u64().ok()?;
41
42		Some(Self {
43			namespace: NamespaceId(namespace),
44		})
45	}
46}
47
48impl NamespaceKey {
49	pub fn full_scan() -> EncodedKeyRange {
50		EncodedKeyRange::start_end(Some(Self::namespace_start()), Some(Self::namespace_end()))
51	}
52
53	fn namespace_start() -> EncodedKey {
54		let mut serializer = KeySerializer::with_capacity(2);
55		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8);
56		serializer.to_encoded_key()
57	}
58
59	fn namespace_end() -> EncodedKey {
60		let mut serializer = KeySerializer::with_capacity(2);
61		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8 - 1);
62		serializer.to_encoded_key()
63	}
64}
65
66#[cfg(test)]
67mod tests {
68	use super::{EncodableKey, NamespaceKey};
69	use crate::interface::catalog::NamespaceId;
70
71	#[test]
72	fn test_encode_decode() {
73		let key = NamespaceKey {
74			namespace: NamespaceId(0xABCD),
75		};
76		let encoded = key.encode();
77		let expected = vec![0xFE, 0xFE, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x54, 0x32];
78		assert_eq!(encoded.as_slice(), expected);
79
80		let key = NamespaceKey::decode(&encoded).unwrap();
81		assert_eq!(key.namespace, 0xABCD);
82	}
83}
reifydb_core/key/namespace.rs

reifydb_core/key/
namespace.rs
