Skip to content

add MSRV, MSRV badge & bump cc & fix readme #171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chirizxc wants to merge 2 commits into
base: master
Choose a base branch
from
+12 −7
Open

add MSRV, MSRV badge & bump cc & fix readme #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4c4a90
add MSRV, MSRV badge & bump cc
chirizxc Aug 7, 2026
2bc900b
ini -> toml
chirizxc Aug 11, 2026
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
View file
Open in desktop
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
15 changes: 9 additions & 6 deletions README.md
View file
Open in desktop
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,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"] }
```
Expand All @@ -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"] }
```
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
View file
Open in desktop
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"

@chirizxc chirizxc Aug 7, 2026

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