Skip to main content

reifydb_core/key/
namespace_source.rs

1// SPDX-License-Identifier: Apache-2.0
2// Copyright (c) 2025 ReifyDB
3
4use super::{EncodableKey, KeyKind};
5use crate::{
6	encoded::key::{EncodedKey, EncodedKeyRange},
7	interface::catalog::id::{NamespaceId, SourceId},
8	util::encoding::keycode::{deserializer::KeyDeserializer, serializer::KeySerializer},
9};
10
11#[derive(Debug, Clone, PartialEq)]
12pub struct NamespaceSourceKey {
13	pub namespace: NamespaceId,
14	pub source: SourceId,
15}
16
17impl EncodableKey for NamespaceSourceKey {
18	const KIND: KeyKind = KeyKind::NamespaceSource;
19
20	fn encode(&self) -> EncodedKey {
21		let mut serializer = KeySerializer::with_capacity(17);
22		serializer.extend_u8(Self::KIND as u8).extend_u64(self.namespace).extend_u64(self.source);
23		serializer.to_encoded_key()
24	}
25
26	fn decode(key: &EncodedKey) -> Option<Self> {
27		let mut de = KeyDeserializer::from_bytes(key.as_slice());
28
29		let kind: KeyKind = de.read_u8().ok()?.try_into().ok()?;
30		if kind != Self::KIND {
31			return None;
32		}
33
34		let namespace = de.read_u64().ok()?;
35		let source = de.read_u64().ok()?;
36
37		Some(Self {
38			namespace: NamespaceId(namespace),
39			source: SourceId(source),
40		})
41	}
42}
43
44impl NamespaceSourceKey {
45	pub fn encoded(namespace: impl Into<NamespaceId>, source: impl Into<SourceId>) -> EncodedKey {
46		Self {
47			namespace: namespace.into(),
48			source: source.into(),
49		}
50		.encode()
51	}
52
53	pub fn full_scan(namespace_id: NamespaceId) -> EncodedKeyRange {
54		EncodedKeyRange::start_end(Some(Self::link_start(namespace_id)), Some(Self::link_end(namespace_id)))
55	}
56
57	fn link_start(namespace_id: NamespaceId) -> EncodedKey {
58		let mut serializer = KeySerializer::with_capacity(9);
59		serializer.extend_u8(Self::KIND as u8).extend_u64(namespace_id);
60		serializer.to_encoded_key()
61	}
62
63	fn link_end(namespace_id: NamespaceId) -> EncodedKey {
64		let mut serializer = KeySerializer::with_capacity(9);
65		serializer.extend_u8(Self::KIND as u8).extend_u64(*namespace_id - 1);
66		serializer.to_encoded_key()
67	}
68}
69
70#[cfg(test)]
71pub mod tests {
72	use super::{EncodableKey, NamespaceSourceKey};
73	use crate::interface::catalog::id::{NamespaceId, SourceId};
74
75	#[test]
76	fn test_encode_decode() {
77		let key = NamespaceSourceKey {
78			namespace: NamespaceId(0xABCD),
79			source: SourceId(0x123456789ABCDEF0),
80		};
81		let encoded = key.encode();
82		let decoded = NamespaceSourceKey::decode(&encoded).unwrap();
83		assert_eq!(decoded.namespace, NamespaceId(0xABCD));
84		assert_eq!(decoded.source, SourceId(0x123456789ABCDEF0));
85		assert_eq!(key, decoded);
86	}
87
88	#[test]
89	fn test_order_preserving() {
90		let key1 = NamespaceSourceKey {
91			namespace: NamespaceId::SYSTEM,
92			source: SourceId(100),
93		};
94		let key2 = NamespaceSourceKey {
95			namespace: NamespaceId::SYSTEM,
96			source: SourceId(200),
97		};
98		let key3 = NamespaceSourceKey {
99			namespace: NamespaceId::DEFAULT,
100			source: SourceId(0),
101		};
102
103		let encoded1 = key1.encode();
104		let encoded2 = key2.encode();
105		let encoded3 = key3.encode();
106
107		assert!(encoded3 < encoded2, "ordering not preserved");
108		assert!(encoded2 < encoded1, "ordering not preserved");
109	}
110}