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

reifydb_core/key/
namespace_flow.rs
