reifydb_core/key/
flow_edge.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::{FlowEdgeId, FlowId},
8	util::encoding::keycode::{KeyDeserializer, KeySerializer},
9};
10
11#[derive(Debug, Clone, PartialEq)]
12pub struct FlowEdgeKey {
13	pub edge: FlowEdgeId,
14}
15
16const VERSION: u8 = 1;
17
18impl EncodableKey for FlowEdgeKey {
19	const KIND: KeyKind = KeyKind::FlowEdge;
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.edge);
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 edge = de.read_u64().ok()?;
41
42		Some(Self {
43			edge: FlowEdgeId(edge),
44		})
45	}
46}
47
48impl FlowEdgeKey {
49	pub fn full_scan() -> EncodedKeyRange {
50		EncodedKeyRange::start_end(Some(Self::start()), Some(Self::end()))
51	}
52
53	fn 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 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#[derive(Debug, Clone, PartialEq)]
67pub struct FlowEdgeByFlowKey {
68	pub flow: FlowId,
69	pub edge: FlowEdgeId,
70}
71
72impl EncodableKey for FlowEdgeByFlowKey {
73	const KIND: KeyKind = KeyKind::FlowEdgeByFlow;
74
75	fn encode(&self) -> EncodedKey {
76		let mut serializer = KeySerializer::with_capacity(18);
77		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(self.flow).extend_u64(self.edge);
78		serializer.to_encoded_key()
79	}
80
81	fn decode(key: &EncodedKey) -> Option<Self> {
82		let mut de = KeyDeserializer::from_bytes(key.as_slice());
83
84		let version = de.read_u8().ok()?;
85		if version != VERSION {
86			return None;
87		}
88
89		let kind: KeyKind = de.read_u8().ok()?.try_into().ok()?;
90		if kind != Self::KIND {
91			return None;
92		}
93
94		let flow = de.read_u64().ok()?;
95		let edge = de.read_u64().ok()?;
96
97		Some(Self {
98			flow: FlowId(flow),
99			edge: FlowEdgeId(edge),
100		})
101	}
102}
103
104impl FlowEdgeByFlowKey {
105	pub fn full_scan(flow: FlowId) -> EncodedKeyRange {
106		EncodedKeyRange::start_end(Some(Self::start(flow)), Some(Self::end(flow)))
107	}
108
109	fn start(flow: FlowId) -> EncodedKey {
110		let mut serializer = KeySerializer::with_capacity(10);
111		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(flow);
112		serializer.to_encoded_key()
113	}
114
115	fn end(flow: FlowId) -> EncodedKey {
116		let mut serializer = KeySerializer::with_capacity(10);
117		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(FlowId(flow.0 - 1));
118		serializer.to_encoded_key()
119	}
120}
121
122#[cfg(test)]
123mod tests {
124	use super::{EncodableKey, FlowEdgeByFlowKey, FlowEdgeKey};
125	use crate::interface::catalog::{FlowEdgeId, FlowId};
126
127	#[test]
128	fn test_flow_edge_key_encode_decode() {
129		let key = FlowEdgeKey {
130			edge: FlowEdgeId(0x1234),
131		};
132		let encoded = key.encode();
133		let decoded = FlowEdgeKey::decode(&encoded).unwrap();
134		assert_eq!(decoded.edge, FlowEdgeId(0x1234));
135		assert_eq!(key, decoded);
136	}
137
138	#[test]
139	fn test_flow_edge_by_flow_key_encode_decode() {
140		let key = FlowEdgeByFlowKey {
141			flow: FlowId(0x42),
142			edge: FlowEdgeId(0x1234),
143		};
144		let encoded = key.encode();
145		let decoded = FlowEdgeByFlowKey::decode(&encoded).unwrap();
146		assert_eq!(decoded.flow, FlowId(0x42));
147		assert_eq!(decoded.edge, FlowEdgeId(0x1234));
148		assert_eq!(key, decoded);
149	}
150}