Skip to main content

reifydb_core/key/
user_role.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::user::{RoleId, UserId},
8	util::encoding::keycode::{deserializer::KeyDeserializer, serializer::KeySerializer},
9};
10
11const VERSION: u8 = 1;
12
13#[derive(Debug, Clone, PartialEq)]
14pub struct UserRoleKey {
15	pub user: UserId,
16	pub role: RoleId,
17}
18
19impl UserRoleKey {
20	pub fn new(user: UserId, role: RoleId) -> Self {
21		Self {
22			user,
23			role,
24		}
25	}
26
27	pub fn encoded(user: UserId, role: RoleId) -> EncodedKey {
28		Self::new(user, role).encode()
29	}
30
31	pub fn full_scan() -> EncodedKeyRange {
32		let mut start = KeySerializer::with_capacity(2);
33		start.extend_u8(VERSION).extend_u8(Self::KIND as u8);
34		let mut end = KeySerializer::with_capacity(2);
35		end.extend_u8(VERSION).extend_u8(Self::KIND as u8 - 1);
36		EncodedKeyRange::start_end(Some(start.to_encoded_key()), Some(end.to_encoded_key()))
37	}
38
39	pub fn user_scan(user: UserId) -> EncodedKeyRange {
40		let mut start = KeySerializer::with_capacity(10);
41		start.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(user);
42		let mut end = KeySerializer::with_capacity(10);
43		end.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(user);
44		// The end key needs to be exclusive-upper, so we add a byte past the prefix
45		let start_key = start.to_encoded_key();
46		let mut end_bytes = end.to_encoded_key().to_vec();
47		end_bytes.push(0xFF);
48		EncodedKeyRange::start_end(Some(start_key), Some(EncodedKey::new(end_bytes)))
49	}
50}
51
52impl EncodableKey for UserRoleKey {
53	const KIND: KeyKind = KeyKind::UserRole;
54
55	fn encode(&self) -> EncodedKey {
56		let mut serializer = KeySerializer::with_capacity(18);
57		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(self.user).extend_u64(self.role);
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		let version = de.read_u8().ok()?;
64		if version != VERSION {
65			return None;
66		}
67		let kind: KeyKind = de.read_u8().ok()?.try_into().ok()?;
68		if kind != Self::KIND {
69			return None;
70		}
71		let user = de.read_u64().ok()?;
72		let role = de.read_u64().ok()?;
73		Some(Self {
74			user,
75			role,
76		})
77	}
78}