We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 45889fe commit 1c00a97Copy full SHA for 1c00a97
README.md
@@ -28,5 +28,14 @@ pub fn init_heap() {
28
}
29
```
30
31
+## Features
32
+
33
+- **`use_spin`** (default): Provide a `LockedHeap` type that implements the [`GlobalAlloc`] trait by using a spinlock.
34
+- **`alloc_ref`**: Provide an implementation of the unstable [`AllocRef`] trait.
35
+ - Warning: The `AllocRef` trait is still regularly changed on the Rust side, so expect some regular breakage when using this feature.
36
37
+[`GlobalAlloc`]: https://doc.rust-lang.org/nightly/core/alloc/trait.GlobalAlloc.html
38
+[`AllocRef`]: https://doc.rust-lang.org/nightly/core/alloc/trait.AllocRef.html
39
40
## License
41
This crate is dual-licensed under MIT or the Apache License (Version 2.0). See LICENSE-APACHE and LICENSE-MIT for details.
0 commit comments