reifydb_core/key/
columns.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,
8	util::encoding::keycode::{KeyDeserializer, KeySerializer},
9};
10
11#[derive(Debug, Clone, PartialEq)]
12pub struct ColumnsKey {
13	pub column: ColumnId,
14}
15
16const VERSION: u8 = 1;
17
18impl EncodableKey for ColumnsKey {
19	const KIND: KeyKind = KeyKind::Columns;
20
21	fn encode(&self) -> EncodedKey {
22		let mut serializer = KeySerializer::with_capacity(10);
23		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(self.column);
24		serializer.to_encoded_key()
25	}
26
27	fn decode(key: &EncodedKey) -> Option<Self> {
28		let mut de = KeyDeserializer::from_bytes(key.as_slice());
29
30		let version = de.read_u8().ok()?;
31		if version != VERSION {
32			return None;
33		}
34
35		let kind: KeyKind = de.read_u8().ok()?.try_into().ok()?;
36		if kind != Self::KIND {
37			return None;
38		}
39
40		let column = de.read_u64().ok()?;
41
42		Some(Self {
43			column: ColumnId(column),
44		})
45	}
46}
47
48impl ColumnsKey {
49	pub fn full_scan() -> EncodedKeyRange {
50		EncodedKeyRange::start_end(Some(Self::column_start()), Some(Self::column_end()))
51	}
52
53	fn column_start() -> EncodedKey {
54		let mut serializer = KeySerializer::with_capacity(2);
55		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8);
56		serializer.to_encoded_key()
57	}
58
59	fn column_end() -> EncodedKey {
60		let mut serializer = KeySerializer::with_capacity(2);
61		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8 - 1);
62		serializer.to_encoded_key()
63	}
64}
65
66#[cfg(test)]
67mod tests {
68	use super::{ColumnsKey, EncodableKey};
69	use crate::interface::catalog::ColumnId;
70
71	#[test]
72	fn test_encode_decode() {
73		let key = ColumnsKey {
74			column: ColumnId(0xABCD),
75		};
76		let encoded = key.encode();
77		let expected = vec![
78			0xFE, // version
79			0xF9, // kind
80			0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x54, 0x32,
81		];
82		assert_eq!(encoded.as_slice(), expected);
83
84		let key = ColumnsKey::decode(&encoded).unwrap();
85		assert_eq!(key.column, 0xABCD);
86	}
87}
reifydb_core/key/columns.rs

reifydb_core/key/
columns.rs
