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 full_scan(source: impl Into<SourceId>) -> EncodedKeyRange {
56		let source = source.into();
57		EncodedKeyRange::start_end(Some(Self::start(source)), Some(Self::end(source)))
58	}
59
60	fn start(source: SourceId) -> EncodedKey {
61		let mut serializer = KeySerializer::with_capacity(11);
62		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_source_id(source);
63		serializer.to_encoded_key()
64	}
65
66	fn end(source: SourceId) -> EncodedKey {
67		let mut serializer = KeySerializer::with_capacity(11);
68		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_source_id(source.prev());
69		serializer.to_encoded_key()
70	}
71}
72
73#[cfg(test)]
74mod tests {
75	use super::EncodableKey;
76	use crate::interface::{
77		ColumnKey,
78		catalog::{ColumnId, SourceId},
79	};
80
81	#[test]
82	fn test_encode_decode() {
83		let key = ColumnKey {
84			source: SourceId::table(0xABCD),
85			column: ColumnId(0x123456789ABCDEF0),
86		};
87		let encoded = key.encode();
88
89		let expected: Vec<u8> = vec![
90			0xFE, // version
91			0xF8, // kind
92			0x01, // SourceId type discriminator (Table)
93			0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x54, 0x32, // source id bytes
94			0xED, 0xCB, 0xA9, 0x87, 0x65, 0x43, 0x21, 0x0F, // column id bytes
95		];
96
97		assert_eq!(encoded.as_slice(), expected);
98
99		let key = ColumnKey::decode(&encoded).unwrap();
100		assert_eq!(key.source, 0xABCD);
101		assert_eq!(key.column, 0x123456789ABCDEF0);
102	}
103
104	#[test]
105	fn test_order_preserving() {
106		let key1 = ColumnKey {
107			source: SourceId::table(1),
108			column: ColumnId(100),
109		};
110		let key2 = ColumnKey {
111			source: SourceId::table(1),
112			column: ColumnId(200),
113		};
114		let key3 = ColumnKey {
115			source: SourceId::table(2),
116			column: ColumnId(0),
117		};
118
119		let encoded1 = key1.encode();
120		let encoded2 = key2.encode();
121		let encoded3 = key3.encode();
122
123		assert!(encoded3 < encoded2, "ordering not preserved");
124		assert!(encoded2 < encoded1, "ordering not preserved");
125	}
126}
reifydb_core/key/column.rs

reifydb_core/key/
column.rs
