Skip to main content

reifydb_core/key/
view.rs

1// SPDX-License-Identifier: Apache-2.0
2// Copyright (c) 2025 ReifyDB
3
4use super::{EncodableKey, KeyKind};
5use crate::{
6	encoded::key::{EncodedKey, EncodedKeyRange},
7	interface::catalog::id::ViewId,
8	util::encoding::keycode::{deserializer::KeyDeserializer, serializer::KeySerializer},
9};
10
11#[derive(Debug, Clone, PartialEq)]
12pub struct ViewKey {
13	pub view: ViewId,
14}
15
16impl EncodableKey for ViewKey {
17	const KIND: KeyKind = KeyKind::View;
18
19	fn encode(&self) -> EncodedKey {
20		let mut serializer = KeySerializer::with_capacity(9);
21		serializer.extend_u8(Self::KIND as u8).extend_u64(self.view);
22		serializer.to_encoded_key()
23	}
24
25	fn decode(key: &EncodedKey) -> Option<Self> {
26		let mut de = KeyDeserializer::from_bytes(key.as_slice());
27
28		let kind: KeyKind = de.read_u8().ok()?.try_into().ok()?;
29		if kind != Self::KIND {
30			return None;
31		}
32
33		let view = de.read_u64().ok()?;
34
35		Some(Self {
36			view: ViewId(view),
37		})
38	}
39}
40
41impl ViewKey {
42	pub fn encoded(view: impl Into<ViewId>) -> EncodedKey {
43		Self {
44			view: view.into(),
45		}
46		.encode()
47	}
48
49	pub fn full_scan() -> EncodedKeyRange {
50		EncodedKeyRange::start_end(Some(Self::view_start()), Some(Self::view_end()))
51	}
52
53	fn view_start() -> EncodedKey {
54		let mut serializer = KeySerializer::with_capacity(1);
55		serializer.extend_u8(Self::KIND as u8);
56		serializer.to_encoded_key()
57	}
58
59	fn view_end() -> EncodedKey {
60		let mut serializer = KeySerializer::with_capacity(1);
61		serializer.extend_u8(Self::KIND as u8 - 1);
62		serializer.to_encoded_key()
63	}
64}
65
66#[cfg(test)]
67pub mod tests {
68	use super::{EncodableKey, ViewKey};
69	use crate::interface::catalog::id::ViewId;
70
71	#[test]
72	fn test_encode_decode() {
73		let key = ViewKey {
74			view: ViewId(0xABCD),
75		};
76		let encoded = key.encode();
77		let expected = vec![0xEF, 0x3F, 0x54, 0x32];
78		assert_eq!(encoded.as_slice(), expected);
79
80		let key = ViewKey::decode(&encoded).unwrap();
81		assert_eq!(key.view, 0xABCD);
82	}
83}