reifydb_core/key/
property.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::{ColumnId, ColumnPropertyId},
8	util::encoding::keycode::{deserializer::KeyDeserializer, serializer::KeySerializer},
9};
10
11#[derive(Debug, Clone, PartialEq)]
12pub struct ColumnPropertyKey {
13	pub column: ColumnId,
14	pub property: ColumnPropertyId,
15}
16
17impl EncodableKey for ColumnPropertyKey {
18	const KIND: KeyKind = KeyKind::ColumnProperty;
19
20	fn encode(&self) -> EncodedKey {
21		let mut serializer = KeySerializer::with_capacity(17);
22		serializer.extend_u8(Self::KIND as u8).extend_u64(self.column).extend_u64(self.property);
23		serializer.to_encoded_key()
24	}
25
26	fn decode(key: &EncodedKey) -> Option<Self> {
27		let mut de = KeyDeserializer::from_bytes(key.as_slice());
28
29		let kind: KeyKind = de.read_u8().ok()?.try_into().ok()?;
30		if kind != Self::KIND {
31			return None;
32		}
33
34		let column = de.read_u64().ok()?;
35		let policy = de.read_u64().ok()?;
36
37		Some(Self {
38			column: ColumnId(column),
39			property: ColumnPropertyId(policy),
40		})
41	}
42}
43
44impl ColumnPropertyKey {
45	pub fn encoded(column: impl Into<ColumnId>, property: impl Into<ColumnPropertyId>) -> EncodedKey {
46		Self {
47			column: column.into(),
48			property: property.into(),
49		}
50		.encode()
51	}
52
53	pub fn full_scan(column: ColumnId) -> EncodedKeyRange {
54		EncodedKeyRange::start_end(Some(Self::link_start(column)), Some(Self::link_end(column)))
55	}
56
57	fn link_start(column: ColumnId) -> EncodedKey {
58		let mut serializer = KeySerializer::with_capacity(9);
59		serializer.extend_u8(Self::KIND as u8).extend_u64(column);
60		serializer.to_encoded_key()
61	}
62
63	fn link_end(column: ColumnId) -> EncodedKey {
64		let mut serializer = KeySerializer::with_capacity(9);
65		serializer.extend_u8(Self::KIND as u8).extend_u64(*column - 1);
66		serializer.to_encoded_key()
67	}
68}
69
70#[cfg(test)]
71pub mod tests {
72	use super::{ColumnPropertyKey, EncodableKey};
73	use crate::interface::catalog::id::{ColumnId, ColumnPropertyId};
74
75	#[test]
76	fn test_encode_decode() {
77		let key = ColumnPropertyKey {
78			column: ColumnId(0xABCD),
79			property: ColumnPropertyId(0x123456789ABCDEF0),
80		};
81		let encoded = key.encode();
82
83		let expected: Vec<u8> =
84			vec![0xF6, 0x3F, 0x54, 0x32, 0x00, 0xED, 0xCB, 0xA9, 0x87, 0x65, 0x43, 0x21, 0x0F];
85
86		assert_eq!(encoded.as_slice(), expected);
87
88		let key = ColumnPropertyKey::decode(&encoded).unwrap();
89		assert_eq!(key.column, 0xABCD);
90		assert_eq!(key.property, 0x123456789ABCDEF0);
91	}
92
93	#[test]
94	fn test_order_preserving() {
95		let key1 = ColumnPropertyKey {
96			column: ColumnId(1),
97			property: ColumnPropertyId(100),
98		};
99		let key2 = ColumnPropertyKey {
100			column: ColumnId(1),
101			property: ColumnPropertyId(200),
102		};
103		let key3 = ColumnPropertyKey {
104			column: ColumnId(2),
105			property: ColumnPropertyId(0),
106		};
107
108		let encoded1 = key1.encode();
109		let encoded2 = key2.encode();
110		let encoded3 = key3.encode();
111
112		assert!(encoded3 < encoded2, "ordering not preserved");
113		assert!(encoded2 < encoded1, "ordering not preserved");
114	}
115}
reifydb_core/key/property.rs

reifydb_core/key/
property.rs
