Skip to main content

reifydb_core/key/
series.rs

1// SPDX-License-Identifier: AGPL-3.0-or-later
2// Copyright (c) 2025 ReifyDB
3
4use super::{EncodableKey, KeyKind};
5use crate::{
6	encoded::key::{EncodedKey, EncodedKeyRange},
7	interface::catalog::id::SeriesId,
8	util::encoding::keycode::{deserializer::KeyDeserializer, serializer::KeySerializer},
9};
10
11const VERSION: u8 = 1;
12
13#[derive(Debug, Clone, PartialEq)]
14pub struct SeriesKey {
15	pub series: SeriesId,
16}
17
18impl SeriesKey {
19	pub fn new(series: SeriesId) -> Self {
20		Self {
21			series,
22		}
23	}
24
25	pub fn encoded(series: impl Into<SeriesId>) -> EncodedKey {
26		Self::new(series.into()).encode()
27	}
28
29	pub fn full_scan() -> EncodedKeyRange {
30		EncodedKeyRange::start_end(Some(Self::series_start()), Some(Self::series_end()))
31	}
32
33	fn series_start() -> EncodedKey {
34		let mut serializer = KeySerializer::with_capacity(2);
35		serializer.extend_u8(VERSION);
36		serializer.extend_u8(Self::KIND as u8);
37		serializer.to_encoded_key()
38	}
39
40	fn series_end() -> EncodedKey {
41		let mut serializer = KeySerializer::with_capacity(2);
42		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8 - 1);
43		serializer.to_encoded_key()
44	}
45}
46
47impl EncodableKey for SeriesKey {
48	const KIND: KeyKind = KeyKind::Series;
49
50	fn encode(&self) -> EncodedKey {
51		let mut serializer = KeySerializer::with_capacity(10);
52		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(self.series);
53		serializer.to_encoded_key()
54	}
55
56	fn decode(key: &EncodedKey) -> Option<Self> {
57		let mut de = KeyDeserializer::from_bytes(key.as_slice());
58
59		let version = de.read_u8().ok()?;
60		if version != VERSION {
61			return None;
62		}
63
64		let kind: KeyKind = de.read_u8().ok()?.try_into().ok()?;
65		if kind != Self::KIND {
66			return None;
67		}
68
69		let series = de.read_u64().ok()?;
70
71		Some(Self {
72			series: SeriesId(series),
73		})
74	}
75}
76
77#[derive(Debug, Clone, PartialEq)]
78pub struct SeriesMetadataKey {
79	pub series: SeriesId,
80}
81
82impl SeriesMetadataKey {
83	pub fn new(series: SeriesId) -> Self {
84		Self {
85			series,
86		}
87	}
88
89	pub fn encoded(series: impl Into<SeriesId>) -> EncodedKey {
90		Self::new(series.into()).encode()
91	}
92}
93
94impl EncodableKey for SeriesMetadataKey {
95	const KIND: KeyKind = KeyKind::SeriesMetadata;
96
97	fn encode(&self) -> EncodedKey {
98		let mut serializer = KeySerializer::with_capacity(10);
99		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(self.series);
100		serializer.to_encoded_key()
101	}
102
103	fn decode(key: &EncodedKey) -> Option<Self> {
104		let mut de = KeyDeserializer::from_bytes(key.as_slice());
105
106		let version = de.read_u8().ok()?;
107		if version != VERSION {
108			return None;
109		}
110
111		let kind: KeyKind = de.read_u8().ok()?.try_into().ok()?;
112		if kind != Self::KIND {
113			return None;
114		}
115
116		let series = de.read_u64().ok()?;
117
118		Some(Self {
119			series: SeriesId(series),
120		})
121	}
122}