Skip to main content

reifydb_core/key/
property.rs

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