reifydb_core/key/
subscription.rs

1// SPDX-License-Identifier: AGPL-3.0-or-later
2// Copyright (c) 2025 ReifyDB
3
4use super::{EncodableKey, KeyKind};
5use crate::{
6	encoded::key::{EncodedKey, EncodedKeyRange},
7	interface::catalog::id::SubscriptionId,
8	util::encoding::keycode::{deserializer::KeyDeserializer, serializer::KeySerializer},
9};
10
11#[derive(Debug, Clone, PartialEq)]
12pub struct SubscriptionKey {
13	pub subscription: SubscriptionId,
14}
15
16const VERSION: u8 = 1;
17
18impl EncodableKey for SubscriptionKey {
19	const KIND: KeyKind = KeyKind::Subscription;
20
21	fn encode(&self) -> EncodedKey {
22		let mut serializer = KeySerializer::with_capacity(10); // 1 + 1 + 8 bytes for u64
23		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(self.subscription.0);
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 subscription_id = de.read_u64().ok()?;
41
42		Some(Self {
43			subscription: SubscriptionId(subscription_id),
44		})
45	}
46}
47
48impl SubscriptionKey {
49	pub fn encoded(subscription: impl Into<SubscriptionId>) -> EncodedKey {
50		Self {
51			subscription: subscription.into(),
52		}
53		.encode()
54	}
55
56	pub fn full_scan() -> EncodedKeyRange {
57		EncodedKeyRange::start_end(Some(Self::start()), Some(Self::end()))
58	}
59
60	fn start() -> EncodedKey {
61		let mut serializer = KeySerializer::with_capacity(2);
62		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8);
63		serializer.to_encoded_key()
64	}
65
66	fn end() -> EncodedKey {
67		let mut serializer = KeySerializer::with_capacity(2);
68		serializer.extend_u8(VERSION).extend_u8((Self::KIND as u8).wrapping_sub(1));
69		serializer.to_encoded_key()
70	}
71}
72
73#[cfg(test)]
74pub mod tests {
75	use super::{EncodableKey, SubscriptionKey};
76	use crate::interface::catalog::id::SubscriptionId;
77
78	#[test]
79	fn test_encode_decode() {
80		let subscription_id = SubscriptionId(12345);
81		let key = SubscriptionKey {
82			subscription: subscription_id,
83		};
84		let encoded = key.encode();
85
86		let decoded = SubscriptionKey::decode(&encoded).unwrap();
87		assert_eq!(decoded.subscription, subscription_id);
88	}
89}
reifydb_core/key/subscription.rs

reifydb_core/key/
subscription.rs
