Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ authors = [
"Thom Chiovoloni <chiovolonit@gmail.com>",
]
edition = "2018"
rust-version = "1.64"
repository = "https://github.com/purpleprotocol/mimalloc_rust"
keywords = ["mimalloc", "allocator", "encrypted-heap", "performance"]
categories = ["memory-management", "api-bindings"]
Expand Down
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -16,13 +16,13 @@ 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`:
Expand All @@ -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
3 changes: 2 additions & 1 deletion libmimalloc-sys/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name = "libmimalloc-sys"
version = "0.1.49"
authors = ["Octavian Oncescu <octavonce@gmail.com>"]
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"]
Expand Down Expand Up @@ -31,7 +32,7 @@ cty = { version = "0.2", optional = true }
libc = "0.2"

[build-dependencies]
cc = "1.2"
cc = "1.4"

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc 1.2.* MSRV - 1.63
cc 1.4.* MSRV - 1.64


[features]
secure = []
Expand Down