databoard/
lib.rs

1// Copyright © 2025 Stephan Kunz
2#![no_std]
3#![doc = include_str!("../README.md")]
4
5#[cfg(doctest)]
6doc_comment::doctest!("../README.md");
7
8#[doc(hidden)]
9extern crate alloc;
10
11mod database;
12mod databoard;
13mod entry;
14mod error;
15mod remappings;
16
17// flatten
18pub use databoard::Databoard;
19pub use entry::{EntryReadGuard, EntryWriteGuard};
20pub use error::Error;
21pub use remappings::{
22	Remappings, check_board_pointer, check_local_key, check_local_pointer, check_top_level_key, check_top_level_pointer,
23	is_board_pointer, is_const_assignment, is_local_pointer, is_top_level_pointer, strip_board_pointer, strip_local_pointer,
24	strip_top_level_pointer,
25};
26
27/// An immutable thread safe `String` type
28/// see: [Logan Smith](https://www.youtube.com/watch?v=A4cKi7PTJSs).
29type ConstString = alloc::sync::Arc<str>;