reifydb_core/key/
column_policy.rs

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

reifydb_core/key/
column_policy.rs
