reifydb-core 0.4.5

Core database interfaces and data structures for ReifyDB
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2025 ReifyDB

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

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

const VERSION: u8 = 1;

impl EncodableKey for SubscriptionColumnKey {
	const KIND: KeyKind = KeyKind::SubscriptionColumn;

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

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

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

	/// Returns a range for scanning all columns of a specific subscription
	pub fn subscription_range(subscription: impl Into<SubscriptionId>) -> EncodedKeyRange {
		let subscription = subscription.into();
		EncodedKeyRange::start_end(
			Some(Self::subscription_start(subscription)),
			Some(Self::subscription_end(subscription)),
		)
	}

	fn subscription_start(subscription: SubscriptionId) -> EncodedKey {
		let mut serializer = KeySerializer::with_capacity(10);
		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(subscription.0);
		serializer.to_encoded_key()
	}

	fn subscription_end(subscription: SubscriptionId) -> EncodedKey {
		let mut serializer = KeySerializer::with_capacity(10);
		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(subscription.0.wrapping_sub(1));
		serializer.to_encoded_key()
	}
}

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

	#[test]
	fn test_encode_decode() {
		let subscription_id = SubscriptionId(12345);
		let key = SubscriptionColumnKey {
			subscription: subscription_id,
			column: SubscriptionColumnId(0x1234),
		};
		let encoded = key.encode();

		let decoded = SubscriptionColumnKey::decode(&encoded).unwrap();
		assert_eq!(decoded.subscription, subscription_id);
		assert_eq!(decoded.column, SubscriptionColumnId(0x1234));
	}
}