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
17const VERSION: u8 = 1;
18
19impl EncodableKey for ProcedureParamKey {
20	const KIND: KeyKind = KeyKind::ProcedureParam;
21
22	fn encode(&self) -> EncodedKey {
23		let mut serializer = KeySerializer::with_capacity(12);
24		serializer
25			.extend_u8(VERSION)
26			.extend_u8(Self::KIND as u8)
27			.extend_u64(self.procedure)
28			.extend_u16(self.param_index);
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 procedure = de.read_u64().ok()?;
46		let param_index = de.read_u16().ok()?;
47
48		Some(Self {
49			procedure: ProcedureId::from_raw(procedure),
50			param_index,
51		})
52	}
53}
54
55impl ProcedureParamKey {
56	pub fn encoded(procedure: impl Into<ProcedureId>, param_index: u16) -> EncodedKey {
57		Self {
58			procedure: procedure.into(),
59			param_index,
60		}
61		.encode()
62	}
63
64	/// Range covering all parameter rows for a single procedure.
65	pub fn full_scan(procedure: ProcedureId) -> EncodedKeyRange {
66		EncodedKeyRange::start_end(Some(Self::params_start(procedure)), Some(Self::params_end(procedure)))
67	}
68
69	fn params_start(procedure: ProcedureId) -> EncodedKey {
70		let mut serializer = KeySerializer::with_capacity(10);
71		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(procedure);
72		serializer.to_encoded_key()
73	}
74
75	fn params_end(procedure: ProcedureId) -> EncodedKey {
76		let mut serializer = KeySerializer::with_capacity(10);
77		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(*procedure - 1);
78		serializer.to_encoded_key()
79	}
80}
81
82#[cfg(test)]
83pub mod tests {
84	use super::{EncodableKey, ProcedureParamKey};
85	use crate::interface::catalog::id::ProcedureId;
86
87	#[test]
88	fn test_encode_decode() {
89		let key = ProcedureParamKey {
90			procedure: ProcedureId::from_raw(0xCAFE),
91			param_index: 7,
92		};
93		let encoded = key.encode();
94		let key = ProcedureParamKey::decode(&encoded).unwrap();
95		assert_eq!(key.procedure, 0xCAFE);
96		assert_eq!(key.param_index, 7);
97	}
98}
reifydb_core/key/procedure_param.rs

reifydb_core/key/
procedure_param.rs
