reifydb-core 0.4.11

Core database interfaces and data structures for ReifyDB
Documentation
// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2025 ReifyDB

use super::{EncodableKey, KeyKind};
use crate::{
	encoded::key::{EncodedKey, EncodedKeyRange},
	interface::catalog::id::ProcedureId,
	util::encoding::keycode::{deserializer::KeyDeserializer, serializer::KeySerializer},
};

#[derive(Debug, Clone, PartialEq)]
pub struct ProcedureParamKey {
	pub procedure: ProcedureId,
	pub param_index: u16,
}

const VERSION: u8 = 1;

impl EncodableKey for ProcedureParamKey {
	const KIND: KeyKind = KeyKind::ProcedureParam;

	fn encode(&self) -> EncodedKey {
		let mut serializer = KeySerializer::with_capacity(12);
		serializer
			.extend_u8(VERSION)
			.extend_u8(Self::KIND as u8)
			.extend_u64(self.procedure)
			.extend_u16(self.param_index);
		serializer.to_encoded_key()
	}

	fn decode(key: &EncodedKey) -> Option<Self> {
		let mut de = KeyDeserializer::from_bytes(key.as_slice());

		let version = de.read_u8().ok()?;
		if version != VERSION {
			return None;
		}

		let kind: KeyKind = de.read_u8().ok()?.try_into().ok()?;
		if kind != Self::KIND {
			return None;
		}

		let procedure = de.read_u64().ok()?;
		let param_index = de.read_u16().ok()?;

		Some(Self {
			procedure: ProcedureId::from_raw(procedure),
			param_index,
		})
	}
}

impl ProcedureParamKey {
	pub fn encoded(procedure: impl Into<ProcedureId>, param_index: u16) -> EncodedKey {
		Self {
			procedure: procedure.into(),
			param_index,
		}
		.encode()
	}

	/// Range covering all parameter rows for a single procedure.
	pub fn full_scan(procedure: ProcedureId) -> EncodedKeyRange {
		EncodedKeyRange::start_end(Some(Self::params_start(procedure)), Some(Self::params_end(procedure)))
	}

	fn params_start(procedure: ProcedureId) -> EncodedKey {
		let mut serializer = KeySerializer::with_capacity(10);
		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(procedure);
		serializer.to_encoded_key()
	}

	fn params_end(procedure: ProcedureId) -> EncodedKey {
		let mut serializer = KeySerializer::with_capacity(10);
		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(*procedure - 1);
		serializer.to_encoded_key()
	}
}

#[cfg(test)]
pub mod tests {
	use super::{EncodableKey, ProcedureParamKey};
	use crate::interface::catalog::id::ProcedureId;

	#[test]
	fn test_encode_decode() {
		let key = ProcedureParamKey {
			procedure: ProcedureId::from_raw(0xCAFE),
			param_index: 7,
		};
		let encoded = key.encode();
		let key = ProcedureParamKey::decode(&encoded).unwrap();
		assert_eq!(key.procedure, 0xCAFE);
		assert_eq!(key.param_index, 7);
	}
}