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 remapping_helper;
16mod remapping_list;
17mod remapping_target;
18
19// flatten
20pub use databoard::Databoard;
21pub use entry::{EntryReadGuard, EntryWriteGuard};
22pub use error::Error;
23pub use remapping_helper::{
24	check_board_pointer, check_local_key, check_local_pointer, check_top_level_key, check_top_level_pointer,
25	is_board_pointer, is_const_assignment, is_local_pointer, is_top_level_pointer, strip_board_pointer, strip_local_pointer,
26	strip_top_level_pointer,
27};
28pub use remapping_list::RemappingList;
29pub use remapping_target::RemappingTarget;
30
31/// An immutable thread safe `String` type
32/// see: [Logan Smith](https://www.youtube.com/watch?v=A4cKi7PTJSs).
33type ConstString = alloc::sync::Arc<str>;