reifydb_core/key/
namespace_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::{NamespaceId, RingBufferId},
8	util::encoding::keycode::{KeyDeserializer, KeySerializer},
9};
10
11const VERSION: u8 = 1;
12
13#[derive(Debug, Clone, PartialEq)]
14pub struct NamespaceRingBufferKey {
15	pub namespace: NamespaceId,
16	pub ringbuffer: RingBufferId,
17}
18
19impl NamespaceRingBufferKey {
20	pub fn new(namespace: NamespaceId, ringbuffer: RingBufferId) -> Self {
21		Self {
22			namespace,
23			ringbuffer,
24		}
25	}
26
27	pub fn encoded(namespace: impl Into<NamespaceId>, ringbuffer: impl Into<RingBufferId>) -> EncodedKey {
28		Self::new(namespace.into(), ringbuffer.into()).encode()
29	}
30
31	pub fn full_scan(namespace: NamespaceId) -> EncodedKeyRange {
32		EncodedKeyRange::start_end(Some(Self::link_start(namespace)), Some(Self::link_end(namespace)))
33	}
34
35	fn link_start(namespace: NamespaceId) -> EncodedKey {
36		let mut serializer = KeySerializer::with_capacity(10);
37		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(namespace);
38		serializer.to_encoded_key()
39	}
40
41	fn link_end(namespace: NamespaceId) -> EncodedKey {
42		let mut serializer = KeySerializer::with_capacity(10);
43		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(*namespace - 1);
44		serializer.to_encoded_key()
45	}
46}
47
48impl EncodableKey for NamespaceRingBufferKey {
49	const KIND: KeyKind = KeyKind::NamespaceRingBuffer;
50
51	fn encode(&self) -> EncodedKey {
52		let mut serializer = KeySerializer::with_capacity(18);
53		serializer
54			.extend_u8(VERSION)
55			.extend_u8(Self::KIND as u8)
56			.extend_u64(self.namespace)
57			.extend_u64(self.ringbuffer);
58		serializer.to_encoded_key()
59	}
60
61	fn decode(key: &EncodedKey) -> Option<Self> {
62		let mut de = KeyDeserializer::from_bytes(key.as_slice());
63
64		let version = de.read_u8().ok()?;
65		if version != VERSION {
66			return None;
67		}
68
69		let kind: KeyKind = de.read_u8().ok()?.try_into().ok()?;
70		if kind != Self::KIND {
71			return None;
72		}
73
74		let namespace = de.read_u64().ok()?;
75		let ringbuffer = de.read_u64().ok()?;
76
77		Some(Self {
78			namespace: NamespaceId(namespace),
79			ringbuffer: RingBufferId(ringbuffer),
80		})
81	}
82}