jemallocator/README.md

48 lines
1.2 KiB
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
2017-10-30 21:11:08 +00:00
This project is licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
http://opensource.org/licenses/MIT)
at your option.
### Contribution
2016-01-21 01:06:21 +00:00
Unless you explicitly state otherwise, any contribution intentionally submitted
2018-02-01 12:18:12 +00:00
for inclusion in jemallocator by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.