File tree Expand file tree Collapse file tree 2 files changed +17
-4
lines changed
Expand file tree Collapse file tree 2 files changed +17
-4
lines changed Original file line number Diff line number Diff line change 11[package ]
22name = " mimalloc"
33version = " 0.1.2"
4- authors = [" Octavian Oncescu <octavonce@gmail.com>" ]
4+ authors = [
5+ " Octavian Oncescu <octavonce@gmail.com>" ,
6+ " Vincent Rouillé <vincent@speedy37.fr>" ,
7+ ]
58edition = " 2018"
69repository = " https://github.com/purpleprotocol/mimalloc_rust"
710keywords = [" mimalloc" , " allocator" , " encrypted-heap" , " performance" ]
Original file line number Diff line number Diff line change 11# Mimalloc Rust
2+
23[ ![ Build Status] ( https://travis-ci.org/purpleprotocol/mimalloc_rust.svg?branch=master )] ( https://travis-ci.org/purpleprotocol/mimalloc_rust ) [ ![ Latest Version]] [ crates.io ] [ ![ Documentation]] [ docs.rs ]
34
45A drop-in global allocator wrapper around the [ mimalloc] ( https://github.com/microsoft/mimalloc ) allocator.
56Mimalloc is a general purpose, performance oriented allocator built by Microsoft.
67
78## Usage
9+
810``` rust
911use mimalloc :: MiMalloc ;
1012
1113#[global_allocator]
1214static GLOBAL : MiMalloc = MiMalloc ;
1315```
1416
17+ ## Requirements
18+
19+ [ CMake] ( https://cmake.org/ ) and a __ C__ compiler are required for building
20+ [ mimalloc] ( https://github.com/microsoft/mimalloc ) with cargo.
21+
1522## Usage without secure mode
16- By default this library builds mimalloc in secure mode. This means that
17- heap allocations are encrypted, but this results in a 3% increase in overhead.
23+
24+ By default this library builds mimalloc in secure mode. This add guard pages,
25+ randomized allocation, encrypted free lists, etc. The performance penalty should
26+ only be around 3% according to [ mimalloc] ( https://github.com/microsoft/mimalloc )
27+ own benchmarks.
1828
1929To disable secure mode, in ` Cargo.toml ` :
2030``` rust
@@ -25,4 +35,4 @@ mimalloc = { version = "*", default-features = false }
2535[ crates.io ] : https://crates.io/crates/mimalloc
2636[ Latest Version ] : https://img.shields.io/crates/v/mimalloc.svg
2737[ Documentation ] : https://docs.rs/mimalloc/badge.svg
28- [ docs.rs ] : https://docs.rs/mimalloc
38+ [ docs.rs ] : https://docs.rs/mimalloc
You can’t perform that action at this time.
0 commit comments