reifydb_core/key/
system_sequence.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::SequenceId,
8	util::encoding::keycode::{KeyDeserializer, KeySerializer},
9};
10
11#[derive(Debug, Clone, PartialEq)]
12pub struct SystemSequenceKey {
13	pub sequence: SequenceId,
14}
15
16const VERSION: u8 = 1;
17
18impl EncodableKey for SystemSequenceKey {
19	const KIND: KeyKind = KeyKind::SystemSequence;
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.sequence.0);
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 sequence = de.read_u64().ok()?;
41
42		Some(Self {
43			sequence: SequenceId(sequence),
44		})
45	}
46}
47
48impl SystemSequenceKey {
49	pub fn encoded(sequence: impl Into<SequenceId>) -> EncodedKey {
50		Self {
51			sequence: sequence.into(),
52		}
53		.encode()
54	}
55
56	pub fn full_scan() -> EncodedKeyRange {
57		EncodedKeyRange::start_end(Some(Self::sequence_start()), Some(Self::sequence_end()))
58	}
59
60	fn sequence_start() -> EncodedKey {
61		let mut serializer = KeySerializer::with_capacity(2);
62		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8);
63		serializer.to_encoded_key()
64	}
65
66	fn sequence_end() -> EncodedKey {
67		let mut serializer = KeySerializer::with_capacity(2);
68		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8 - 1);
69		serializer.to_encoded_key()
70	}
71}
72
73#[cfg(test)]
74mod tests {
75	use super::{EncodableKey, SystemSequenceKey};
76	use crate::interface::catalog::SequenceId;
77
78	#[test]
79	fn test_encode_decode() {
80		let key = SystemSequenceKey {
81			sequence: SequenceId(0xABCD),
82		};
83		let encoded = key.encode();
84		let expected = vec![
85			0xFE, // version
86			0xFA, // kind
87			0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x54, 0x32,
88		];
89		assert_eq!(encoded.as_slice(), expected);
90
91		let key = SystemSequenceKey::decode(&encoded).unwrap();
92		assert_eq!(key.sequence.0, 0xABCD);
93	}
94}
reifydb_core/key/system_sequence.rs

reifydb_core/key/
system_sequence.rs
