Skip to main content

reifydb_core/key/
procedure_param.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::ProcedureId,
8	util::encoding::keycode::{deserializer::KeyDeserializer, serializer::KeySerializer},
9};
10
11#[derive(Debug, Clone, PartialEq)]
12pub struct ProcedureParamKey {
13	pub procedure: ProcedureId,
14	pub param_index: u16,
15}
16
17impl EncodableKey for ProcedureParamKey {
18	const KIND: KeyKind = KeyKind::ProcedureParam;
19
20	fn encode(&self) -> EncodedKey {
21		let mut serializer = KeySerializer::with_capacity(11);
22		serializer.extend_u8(Self::KIND as u8).extend_u64(self.procedure).extend_u16(self.param_index);
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 procedure = de.read_u64().ok()?;
35		let param_index = de.read_u16().ok()?;
36
37		Some(Self {
38			procedure: ProcedureId::from_raw(procedure),
39			param_index,
40		})
41	}
42}
43
44impl ProcedureParamKey {
45	pub fn encoded(procedure: impl Into<ProcedureId>, param_index: u16) -> EncodedKey {
46		Self {
47			procedure: procedure.into(),
48			param_index,
49		}
50		.encode()
51	}
52
53	pub fn full_scan(procedure: ProcedureId) -> EncodedKeyRange {
54		EncodedKeyRange::start_end(Some(Self::params_start(procedure)), Some(Self::params_end(procedure)))
55	}
56
57	fn params_start(procedure: ProcedureId) -> EncodedKey {
58		let mut serializer = KeySerializer::with_capacity(9);
59		serializer.extend_u8(Self::KIND as u8).extend_u64(procedure);
60		serializer.to_encoded_key()
61	}
62
63	fn params_end(procedure: ProcedureId) -> EncodedKey {
64		let mut serializer = KeySerializer::with_capacity(9);
65		serializer.extend_u8(Self::KIND as u8).extend_u64(*procedure - 1);
66		serializer.to_encoded_key()
67	}
68}
69
70#[cfg(test)]
71pub mod tests {
72	use super::{EncodableKey, ProcedureParamKey};
73	use crate::interface::catalog::id::ProcedureId;
74
75	#[test]
76	fn test_encode_decode() {
77		let key = ProcedureParamKey {
78			procedure: ProcedureId::from_raw(0xCAFE),
79			param_index: 7,
80		};
81		let encoded = key.encode();
82		let key = ProcedureParamKey::decode(&encoded).unwrap();
83		assert_eq!(key.procedure, 0xCAFE);
84		assert_eq!(key.param_index, 7);
85	}
86}