databoard 0.3.1

Provides a hierarchical key-value-store
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

// Copyright © 2025 Stephan Kunz
//! Implements [`databoard`][`Remappings`] and helper functions handling the remapping rules.

// region:		--- helpers
/// Returns `true` if a key is a valid databoard key, otherwise `false`
#[must_use]
fn is_valid_db_key(key: &str) -> bool {
	!key.contains('"') && !key.contains('\'') && !key.contains(':') && !key.contains('{') && !key.contains('}')
}

/// Returns `true` if a key is not a board pointer but a constant assignment , otherwise `false`
#[must_use]
pub fn is_const_assignment(key: &str) -> bool {
	!key.starts_with('{') && !key.ends_with('}') || key.contains('"') || key.contains(':') || key.contains('\'')
}

/// Checks whether the given key is a pointer into a [`Databoard`](crate::databoard).
#[must_use]
pub fn is_board_pointer(key: &str) -> bool {
	key.starts_with('{') && key.ends_with('}') && is_valid_db_key(&key[1..key.len() - 1])
}

/// Returns Some(literal) of the [`Databoard`](crate::databoard) pointer if it is one, otherwise `None`.
#[must_use]
pub fn strip_board_pointer(key: &str) -> Option<&str> {
	if is_board_pointer(key) {
		Some(&key[1..key.len() - 1])
	} else {
		None
	}
}

/// Returns the literal of the [`Databoard`](crate::databoard) pointer if it is one.
/// # Errors
/// - if is not a [`Databoard`](crate::databoard) pointer, the error contains the unchanged key.
pub fn check_board_pointer(key: &str) -> core::result::Result<&str, &str> {
	if is_board_pointer(key) {
		Ok(&key[1..key.len() - 1])
	} else {
		Err(key)
	}
}

/// Returns the literal of the current/local [`Databoard`](crate::databoard) key if it is one.
/// # Errors
/// - if is not a current/local [`Databoard`](crate::databoard) `key`, the error contains the unchanged `key`.
pub fn check_local_key(key: &str) -> core::result::Result<&str, &str> {
	if key.starts_with('_') && is_valid_db_key(&key[1..]) {
		Ok(&key[1..])
	} else {
		Err(key)
	}
}

/// Checks whether the given key is a pointer into current/local [`Databoard`](crate::databoard).
#[must_use]
pub fn is_local_pointer(key: &str) -> bool {
	key.starts_with("{_") && key.ends_with('}') && is_valid_db_key(&key[2..key.len() - 1])
}

/// Returns Some(literal) of the current/local [`Databoard`](crate::databoard) pointer if it is one, otherwise `None`.
/// The leading `_` is removed from the literal.
#[must_use]
pub fn strip_local_pointer(key: &str) -> Option<&str> {
	if is_local_pointer(key) {
		Some(&key[2..key.len() - 1])
	} else {
		None
	}
}

/// Returns the literal of the current/local [`Databoard`](crate::databoard) pointer if it is one.
/// # Errors
/// - if is not a current/local [`Databoard`](crate::databoard) pointer, the error contains the unchanged key.
pub fn check_local_pointer(key: &str) -> core::result::Result<&str, &str> {
	if is_local_pointer(key) {
		Ok(&key[2..key.len() - 1])
	} else {
		Err(key)
	}
}

/// Returns the literal of the top level [`Databoard`](crate::databoard) key if it is one.
/// # Errors
/// - if is not a top level [`Databoard`](crate::databoard) `key`, the error contains the unchanged `key`.
pub fn check_top_level_key(key: &str) -> core::result::Result<&str, &str> {
	if key.starts_with('@') && is_valid_db_key(&key[1..]) {
		Ok(&key[1..])
	} else {
		Err(key)
	}
}

/// Checks whether the given key is a pointer into top level [`Databoard`](crate::databoard).
#[must_use]
pub fn is_top_level_pointer(key: &str) -> bool {
	key.starts_with("{@") && key.ends_with('}') && is_valid_db_key(&key[2..key.len() - 1])
}

/// Returns Some(literal) of the top level [`Databoard`](crate::databoard) pointer if it is one, otherwise `None`.
/// The leading `@` is removed from the literal.
#[must_use]
pub fn strip_top_level_pointer(key: &str) -> Option<&str> {
	if is_top_level_pointer(key) {
		Some(&key[2..key.len() - 1])
	} else {
		None
	}
}

/// Returns the literal of the top level [`Databoard`](crate::databoard) pointer if it is one.
/// # Errors
/// - if is not a top level [`Databoard`](crate::databoard) pointer, the error contains the unchanged pointer.
pub fn check_top_level_pointer(key: &str) -> core::result::Result<&str, &str> {
	if is_top_level_pointer(key) {
		Ok(&key[2..key.len() - 1])
	} else {
		Err(key)
	}
}

// #[cfg(test)]
// mod tests {
// 	use super::*;

// 	// check, that the auto traits are available
// 	const fn is_normal<T: Sized + Send + Sync>() {}

// 	#[test]
// 	const fn normal_types() {
// 		is_normal::<RemappingList>();
// 		is_normal::<RemappingEntry>();
// 	}
// }