Skip to content

Commit 6d9196f

Browse files
committed
Added note about safety and correctness
1 parent 7da1750 commit 6d9196f

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,17 @@ fn main() {
5555
}
5656
```
5757

58+
## Safety & Correctness
59+
60+
Like most low-level, high-performance data structures written in Rust, this crate makes use of quite
61+
a bit of unsafe Rust code. None of the unsafe Rust code is intended to produce any
62+
unsoundness/undefined behavior or result in any memory unsafety. We have extensively tested the code
63+
with unit tests and [miri], but none of that guarantees that no mistakes have been made. The code
64+
has not been audited and every edge case may not be accounted for. Please keep all of this in mind
65+
if you decide to use this code in your project or as a reference.
66+
67+
[miri]: https://github.com/rust-lang/miri
68+
5869
## Implementation Progress
5970

6071
- [x] `BSTMap`

0 commit comments

Comments
 (0)