surrealdb-core 3.2.3

A scalable, distributed, collaborative, document-graph database, for the realtime web
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

//! Stores the key prefix for all keys under a namespace
use storekey::{BorrowDecode, Encode};

use crate::catalog::NamespaceId;
use crate::key::category::{Categorise, Category};
use crate::kvs::impl_kv_key_storekey;

#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Encode, BorrowDecode)]
pub(crate) struct NamespaceRoot {
	__: u8,
	_a: u8,
	pub ns: NamespaceId,
}

// When querying all keys under a namespace, the output value could be any
// value.
impl_kv_key_storekey!(NamespaceRoot => Vec<u8>);

pub fn new(ns: NamespaceId) -> NamespaceRoot {
	NamespaceRoot::new(ns)
}

impl Categorise for NamespaceRoot {
	fn categorise(&self) -> Category {
		Category::NamespaceRoot
	}
}

impl NamespaceRoot {
	#[inline]
	pub fn new(ns: NamespaceId) -> Self {
		Self {
			__: b'/',
			_a: b'*',
			ns,
		}
	}
}

#[cfg(test)]
mod tests {
	use super::*;
	use crate::kvs::KVKey;

	#[test]
	fn key() {
		let val = NamespaceRoot::new(NamespaceId(1));
		let enc = NamespaceRoot::encode_key(&val).unwrap();
		assert_eq!(enc, b"/*\x00\x00\x00\x01");
	}
}