Skip to main content

reifydb_core/key/
namespace.rs

1// SPDX-License-Identifier: Apache-2.0
2// Copyright (c) 2026 ReifyDB
3
4use reifydb_codec::key::{
5	deserializer::KeyDeserializer,
6	encoded::{EncodedKey, EncodedKeyRange},
7	serializer::KeySerializer,
8};
9
10use super::{EncodableKey, KeyKind};
11use crate::interface::catalog::id::NamespaceId;
12
13#[derive(Debug, Clone, PartialEq)]
14pub struct NamespaceKey {
15	pub namespace: NamespaceId,
16}
17
18impl EncodableKey for NamespaceKey {
19	const KIND: KeyKind = KeyKind::Namespace;
20
21	fn encode(&self) -> EncodedKey {
22		let mut serializer = KeySerializer::with_capacity(9);
23		serializer.extend_u8(Self::KIND as u8).extend_u64(self.namespace.0);
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 kind: KeyKind = de.read_u8().ok()?.try_into().ok()?;
31		if kind != Self::KIND {
32			return None;
33		}
34
35		let namespace = de.read_u64().ok()?;
36
37		Some(Self {
38			namespace: NamespaceId(namespace),
39		})
40	}
41}
42
43impl NamespaceKey {
44	pub fn encoded(namespace: impl Into<NamespaceId>) -> EncodedKey {
45		Self {
46			namespace: namespace.into(),
47		}
48		.encode()
49	}
50
51	pub fn full_scan() -> EncodedKeyRange {
52		EncodedKeyRange::start_end(Some(Self::namespace_start()), Some(Self::namespace_end()))
53	}
54
55	fn namespace_start() -> EncodedKey {
56		let mut serializer = KeySerializer::with_capacity(1);
57		serializer.extend_u8(Self::KIND as u8);
58		serializer.to_encoded_key()
59	}
60
61	fn namespace_end() -> EncodedKey {
62		let mut serializer = KeySerializer::with_capacity(1);
63		serializer.extend_u8(Self::KIND as u8 - 1);
64		serializer.to_encoded_key()
65	}
66}
67
68#[cfg(test)]
69pub mod tests {
70	use super::{EncodableKey, NamespaceKey};
71	use crate::interface::catalog::id::NamespaceId;
72
73	#[test]
74	fn test_encode_decode() {
75		let key = NamespaceKey {
76			namespace: NamespaceId(0xABCD),
77		};
78		let encoded = key.encode();
79		let expected = vec![0xFE, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x54, 0x32];
80		assert_eq!(encoded.as_slice(), expected);
81
82		let key = NamespaceKey::decode(&encoded).unwrap();
83		assert_eq!(key.namespace, 0xABCD);
84	}
85}