jemallocator/README.md

38 lines
908 B
Markdown
Raw Permalink Normal View History

2016-01-21 01:06:21 +00:00
# jemallocator
[![Build Status](https://travis-ci.org/alexcrichton/jemallocator.svg?branch=master)](https://travis-ci.org/alexcrichton/jemallocator)
[Documentation](https://docs.rs/jemallocator)
2016-01-21 01:06:21 +00:00
2016-01-21 01:34:31 +00:00
A nightly-only Rust allocator crate which links to jemalloc and forces all Rust
allocations to use jemalloc as well.
Usage:
```toml
# Cargo.toml
[dependencies]
jemallocator = "0.1"
```
Rust:
```rust
2017-07-07 15:24:26 +00:00
#![feature(global_allocator)]
2016-01-21 01:34:31 +00:00
extern crate jemallocator;
2017-07-07 15:24:26 +00:00
#[global_allocator]
static ALLOC: jemallocator::Jemalloc = jemallocator::Jemalloc;
2016-01-21 01:34:31 +00:00
```
And that's it! Once you've linked to this crate then jemalloc will be used for
all allocations which happen in the crate itself.
2016-01-21 01:06:21 +00:00
# License
`jemallocator` is primarily distributed under the terms of both the MIT license
and the Apache License (Version 2.0), with portions covered by various BSD-like
licenses.
See LICENSE-APACHE, and LICENSE-MIT for details.