reifydb-core 0.4.5

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::SubscriptionId,
	util::encoding::keycode::{deserializer::KeyDeserializer, serializer::KeySerializer},
};

#[derive(Debug, Clone, PartialEq)]
pub struct SubscriptionKey {
	pub subscription: SubscriptionId,
}

const VERSION: u8 = 1;

impl EncodableKey for SubscriptionKey {
	const KIND: KeyKind = KeyKind::Subscription;

	fn encode(&self) -> EncodedKey {
		let mut serializer = KeySerializer::with_capacity(10); // 1 + 1 + 8 bytes for u64
		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(self.subscription.0);
		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 subscription_id = de.read_u64().ok()?;

		Some(Self {
			subscription: SubscriptionId(subscription_id),
		})
	}
}

impl SubscriptionKey {
	pub fn encoded(subscription: impl Into<SubscriptionId>) -> EncodedKey {
		Self {
			subscription: subscription.into(),
		}
		.encode()
	}

	pub fn full_scan() -> EncodedKeyRange {
		EncodedKeyRange::start_end(Some(Self::start()), Some(Self::end()))
	}

	fn start() -> EncodedKey {
		let mut serializer = KeySerializer::with_capacity(2);
		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8);
		serializer.to_encoded_key()
	}

	fn end() -> EncodedKey {
		let mut serializer = KeySerializer::with_capacity(2);
		serializer.extend_u8(VERSION).extend_u8((Self::KIND as u8).wrapping_sub(1));
		serializer.to_encoded_key()
	}
}

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

	#[test]
	fn test_encode_decode() {
		let subscription_id = SubscriptionId(12345);
		let key = SubscriptionKey {
			subscription: subscription_id,
		};
		let encoded = key.encode();

		let decoded = SubscriptionKey::decode(&encoded).unwrap();
		assert_eq!(decoded.subscription, subscription_id);
	}
}