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

reifydb_core/key/
column.rs
