diff --git a/Cargo.toml b/Cargo.toml index fcf6cbe..15c26fa 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,6 +7,7 @@ authors = [ "Thom Chiovoloni ", ] edition = "2018" +rust-version = "1.64" repository = "https://github.com/purpleprotocol/mimalloc_rust" keywords = ["mimalloc", "allocator", "encrypted-heap", "performance"] categories = ["memory-management", "api-bindings"] diff --git a/README.md b/README.md index 4587cf2..cf7f2b5 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Mimalloc Rust -[![Latest Version]][crates.io] [![Documentation]][docs.rs] +[![Latest Version]][crates.io] [![MSRV]][crates.io] [![Documentation]][docs.rs] -A drop-in global allocator wrapper around the [mimalloc](https://github.com/microsoft/mimalloc) allocator. +A drop-in global allocator wrapper around the [mimalloc][gh-mimalloc] allocator. Mimalloc is a general purpose, performance oriented allocator built by Microsoft. ## Usage @@ -16,18 +16,18 @@ static GLOBAL: MiMalloc = MiMalloc; ## Requirements -A __C__ compiler is required for building [mimalloc](https://github.com/microsoft/mimalloc) with cargo. +A __C__ compiler is required for building [mimalloc][gh-mimalloc] with cargo. ## Usage with secure mode Using secure mode adds guard pages, randomized allocation, encrypted free lists, etc. The performance penalty is usually -around 10% according to [mimalloc](https://github.com/microsoft/mimalloc) +around 10% according to [mimalloc][gh-mimalloc] own benchmarks. To enable secure mode, put in `Cargo.toml`: -```ini +```toml [dependencies] mimalloc = { version = "*", features = ["secure"] } ``` @@ -37,7 +37,7 @@ mimalloc = { version = "*", features = ["secure"] } By default this library uses mimalloc `v3`. To use MiMalloc `v2`, write in `Cargo.toml`: -```ini +```toml [dependencies] mimalloc = { version = "*", features = ["v2"] } ``` @@ -46,3 +46,6 @@ mimalloc = { version = "*", features = ["v2"] } [Latest Version]: https://img.shields.io/crates/v/mimalloc.svg [Documentation]: https://docs.rs/mimalloc/badge.svg [docs.rs]: https://docs.rs/mimalloc +[MSRV]: https://img.shields.io/crates/msrv/mimalloc.svg + +[gh-mimalloc]: https://github.com/microsoft/mimalloc \ No newline at end of file diff --git a/libmimalloc-sys/Cargo.toml b/libmimalloc-sys/Cargo.toml index 5e97b9b..26894a1 100644 --- a/libmimalloc-sys/Cargo.toml +++ b/libmimalloc-sys/Cargo.toml @@ -3,6 +3,7 @@ name = "libmimalloc-sys" version = "0.1.49" authors = ["Octavian Oncescu "] edition = "2018" +rust-version = "1.64" repository = "https://github.com/purpleprotocol/mimalloc_rust/tree/master/libmimalloc-sys" keywords = ["allocator", "encrypted-heap", "performance"] categories = ["memory-management", "api-bindings"] @@ -31,7 +32,7 @@ cty = { version = "0.2", optional = true } libc = "0.2" [build-dependencies] -cc = "1.2" +cc = "1.4" [features] secure = []