README.md
1intrusive-collections
2=====================
3
4[](https://travis-ci.org/Amanieu/intrusive-rs) [](https://coveralls.io/github/Amanieu/intrusive-rs?branch=master) [](https://crates.io/crates/intrusive-collections)
5
6A Rust library for creating intrusive collections. Currently supports singly-linked and doubly-linked lists, as well as red-black trees.
7
8## Features
9
10- Compatible with `#[no_std]`.
11- Intrusive collections don't require any dynamic memory allocation since they simply keep track of existing objects rather than allocating new ones.
12- You can safely manipulate intrusive collections without any unsafe code.
13- A single object can be a member of multiple intrusive collections simultaneously.
14- Intrusive collections provide a `Cursor`-based interface, which allows safe mutation while iterating.
15
16For examples and more information, see the documentation ([crates.io](https://docs.rs/intrusive-collections), [master](https://amanieu.github.io/intrusive-rs/intrusive_collections/index.html)).
17
18## Usage
19
20Add this to your `Cargo.toml`:
21
22```toml
23[dependencies]
24intrusive-collections = "0.9"
25```
26
27This crate has two Cargo features:
28
29- `nightly`: Enables nightly-only features: `const fn` constructors for collections (`Link` constructors are always `const fn`)
30- `alloc` (enabled by default): Implements `IntrusivePointer` for `Box`, `Rc` and `Arc`.
31
32## License
33
34Licensed under either of
35
36 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
37 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
38
39at your option.
40
41### Contribution
42
43Unless you explicitly state otherwise, any contribution intentionally submitted
44for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
45additional terms or conditions.
46
){kind=link}
){kind=link}
){kind=link}