57 lines
1.6 KiB
Markdown
57 lines
1.6 KiB
Markdown
# jemallocator-global
|
|
|
|
[![Travis-CI Status]][travis] [![Latest Version]][crates.io] [![docs]][docs.rs]
|
|
|
|
> Sets `jemalloc` as the `#[global allocator]` on targets that support it.
|
|
|
|
## Documentation / usage
|
|
|
|
Add it as a dependency:
|
|
|
|
```toml
|
|
# Cargo.toml
|
|
[dependencies]
|
|
tikv-jemallocator-global = "0.6.0"
|
|
```
|
|
|
|
and `jemalloc` will be used as the `#[global_allocator]` on targets that support
|
|
it.
|
|
|
|
## Cargo features
|
|
|
|
* `force_global_jemalloc` (disabled by default): unconditionally sets `jemalloc`
|
|
as the `#[global_allocator]`.
|
|
|
|
[`tikv-jemallocator`]: https://github.com/tikv/jemallocator/
|
|
|
|
## Platform support
|
|
|
|
See [`jemallocator`]'s platform support.
|
|
|
|
## Documentation
|
|
|
|
For more information check out the [`jemallocator`] crate.
|
|
|
|
## License
|
|
|
|
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
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
|
for inclusion in `tikv-jemallocator-global` by you, as defined in the Apache-2.0 license,
|
|
shall be dual licensed as above, without any additional terms or conditions.
|
|
|
|
[travis]: https://travis-ci.com/tikv/jemallocator
|
|
[Travis-CI Status]: https://travis-ci.com/tikv/jemallocator.svg?branch=master
|
|
[Latest Version]: https://img.shields.io/crates/v/tikv-jemallocator.svg
|
|
[crates.io]: https://crates.io/crates/tikv-jemallocator
|
|
[docs]: https://docs.rs/tikv-jemallocator/badge.svg
|
|
[docs.rs]: https://docs.rs/tikv-jemallocator/
|