surrealdb-core 3.2.0

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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

use revision::revisioned;
use serde::{Deserialize, Serialize};

#[revisioned(revision = 1)]
#[derive(Clone, Default, Debug, Eq, PartialEq, PartialOrd, Deserialize, Serialize, Hash)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
pub enum Level {
	#[default]
	No,
	Root,
	Namespace(String),
	Database(String, String),
	Record(String, String, String),
}

impl std::fmt::Display for Level {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		match self {
			Level::No => write!(f, "No"),
			Level::Root => write!(f, "/"),
			Level::Namespace(ns) => write!(f, "/ns:{ns}/"),
			Level::Database(ns, db) => write!(f, "/ns:{ns}/db:{db}/"),
			Level::Record(ns, db, id) => write!(f, "/ns:{ns}/db:{db}/id:{id}/"),
		}
	}
}

impl Level {
	/// Returns if the level is a sub level of the given level.
	/// For example Level::Namespace is a sublevel of Level::Root, and
	/// Level::Database("foo", "bar") is a sublevel of Level::Namespace("foo").
	/// Every level is also a sublevel of itself.
	pub(crate) fn sublevel_of(&self, other: &Self) -> bool {
		match self {
			Level::No => true,
			Level::Root => matches!(other, Level::Root),
			Level::Namespace(a) => match other {
				Level::Root => true,
				Level::Namespace(b) => a == b,
				_ => false,
			},
			Level::Database(ns0, db0) => match other {
				Level::Root => true,
				Level::Namespace(ns1) => ns0 == ns1,
				Level::Database(ns1, db1) => ns0 == ns1 && db0 == db1,
				_ => false,
			},
			Level::Record(ns0, db0, ac0) => match other {
				Level::Root => true,
				Level::Namespace(ns1) => ns0 == ns1,
				Level::Database(ns1, db1) => ns0 == ns1 && db0 == db1,
				Level::Record(ns1, db1, ac1) => ns0 == ns1 && db0 == db1 && ac0 == ac1,
				_ => false,
			},
		}
	}

	pub(crate) fn ns(&self) -> Option<&str> {
		match self {
			Level::Namespace(ns) => Some(ns),
			Level::Database(ns, _) => Some(ns),
			Level::Record(ns, _, _) => Some(ns),
			_ => None,
		}
	}

	pub(crate) fn db(&self) -> Option<&str> {
		match self {
			Level::Database(_, db) => Some(db),
			Level::Record(_, db, _) => Some(db),
			_ => None,
		}
	}

	pub(crate) fn is_record(&self) -> bool {
		matches!(self, Level::Record(_, _, _))
	}

	pub(crate) fn is_anonymous(&self) -> bool {
		matches!(self, Level::No)
	}

	#[cfg(test)]
	pub(crate) fn id(&self) -> Option<&str> {
		match self {
			Level::Record(_, _, id) => Some(id),
			_ => None,
		}
	}
}