reifydb_core/key/
primary_key.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, EncodedKeyRange, KeyKind};
5use crate::{
6	EncodedKey,
7	interface::PrimaryKeyId,
8	util::encoding::keycode::{KeyDeserializer, KeySerializer},
9};
10
11#[derive(Debug, Clone)]
12pub struct PrimaryKeyKey {
13	pub primary_key: PrimaryKeyId,
14}
15
16const VERSION: u8 = 1;
17
18impl EncodableKey for PrimaryKeyKey {
19	const KIND: KeyKind = KeyKind::PrimaryKey;
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.primary_key);
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 primary_key = de.read_u64().ok()?;
41
42		Some(Self {
43			primary_key: PrimaryKeyId(primary_key),
44		})
45	}
46}
47
48impl PrimaryKeyKey {
49	pub fn encoded(primary_key: impl Into<PrimaryKeyId>) -> EncodedKey {
50		Self {
51			primary_key: primary_key.into(),
52		}
53		.encode()
54	}
55
56	pub fn full_scan() -> EncodedKeyRange {
57		EncodedKeyRange::start_end(Some(Self::primary_key_start()), Some(Self::primary_key_end()))
58	}
59
60	fn primary_key_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 primary_key_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}