Skip to main content

reifydb_core/key/
system_sequence.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::SequenceId,
8	util::encoding::keycode::{deserializer::KeyDeserializer, serializer::KeySerializer},
9};
10
11#[derive(Debug, Clone, PartialEq)]
12pub struct SystemSequenceKey {
13	pub sequence: SequenceId,
14}
15
16impl EncodableKey for SystemSequenceKey {
17	const KIND: KeyKind = KeyKind::SystemSequence;
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.sequence.0);
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 sequence = de.read_u64().ok()?;
34
35		Some(Self {
36			sequence: SequenceId(sequence),
37		})
38	}
39}
40
41impl SystemSequenceKey {
42	pub fn encoded(sequence: impl Into<SequenceId>) -> EncodedKey {
43		Self {
44			sequence: sequence.into(),
45		}
46		.encode()
47	}
48
49	pub fn full_scan() -> EncodedKeyRange {
50		EncodedKeyRange::start_end(Some(Self::sequence_start()), Some(Self::sequence_end()))
51	}
52
53	fn sequence_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 sequence_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, SystemSequenceKey};
69	use crate::interface::catalog::id::SequenceId;
70
71	#[test]
72	fn test_encode_decode() {
73		let key = SystemSequenceKey {
74			sequence: SequenceId(0xABCD),
75		};
76		let encoded = key.encode();
77		let expected = vec![0xFA, 0x3F, 0x54, 0x32];
78		assert_eq!(encoded.as_slice(), expected);
79
80		let key = SystemSequenceKey::decode(&encoded).unwrap();
81		assert_eq!(key.sequence.0, 0xABCD);
82	}
83}