reifydb_core/key/
ringbuffer.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::RingBufferId,
8	util::encoding::keycode::{KeyDeserializer, KeySerializer},
9};
10
11const VERSION: u8 = 1;
12
13#[derive(Debug, Clone, PartialEq)]
14pub struct RingBufferKey {
15	pub ringbuffer: RingBufferId,
16}
17
18impl RingBufferKey {
19	pub fn new(ringbuffer: RingBufferId) -> Self {
20		Self {
21			ringbuffer,
22		}
23	}
24
25	pub fn encoded(ringbuffer: impl Into<RingBufferId>) -> EncodedKey {
26		Self::new(ringbuffer.into()).encode()
27	}
28
29	pub fn full_scan() -> EncodedKeyRange {
30		EncodedKeyRange::start_end(Some(Self::ringbuffer_start()), Some(Self::ringbuffer_end()))
31	}
32
33	fn ringbuffer_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 ringbuffer_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 RingBufferKey {
48	const KIND: KeyKind = KeyKind::RingBuffer;
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.ringbuffer);
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 ringbuffer = de.read_u64().ok()?;
70
71		Some(Self {
72			ringbuffer: RingBufferId(ringbuffer),
73		})
74	}
75}
76
77#[derive(Debug, Clone, PartialEq)]
78pub struct RingBufferMetadataKey {
79	pub ringbuffer: RingBufferId,
80}
81
82impl RingBufferMetadataKey {
83	pub fn new(ringbuffer: RingBufferId) -> Self {
84		Self {
85			ringbuffer,
86		}
87	}
88
89	pub fn encoded(ringbuffer: impl Into<RingBufferId>) -> EncodedKey {
90		Self::new(ringbuffer.into()).encode()
91	}
92}
93
94impl EncodableKey for RingBufferMetadataKey {
95	const KIND: KeyKind = KeyKind::RingBufferMetadata;
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.ringbuffer);
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 ringbuffer = de.read_u64().ok()?;
117
118		Some(Self {
119			ringbuffer: RingBufferId(ringbuffer),
120		})
121	}
122}
reifydb_core/key/ringbuffer.rs

reifydb_core/key/
ringbuffer.rs
