Intrusive collections for Rust
Switch branches/tags
Nothing to show
Clone or download
Latest commit bebd10d Aug 21, 2018

README.md

intrusive-collections

Build Status Coverage Status Crates.io

A Rust library for creating intrusive collections. Currently supports singly-linked and doubly-linked lists, as well as red-black trees.

Features

  • Compatible with #[no_std].
  • Intrusive collections don't require any dynamic memory allocation since they simply keep track of existing objects rather than allocating new ones.
  • You can safely manipulate intrusive collections without any unsafe code.
  • A single object can be a member of multiple intrusive collections simultaneously.
  • Intrusive collections provide a Cursor-based interface, which allows safe mutation while iterating.

For examples and more information, see the documentation (crates.io, master).

Usage

Add this to your Cargo.toml:

[dependencies]
intrusive-collections = "0.6"

and this to your crate root:

#[macro_use]
extern crate intrusive_collections;

This crate has two Cargo features:

  • nightly: Enables nightly-only features: const fn constructors, NonZero support for UnsafeRef.
  • alloc (enabled by default): Implements IntrusivePointer for Box, Rc and Arc. This requires libstd on stable, but only liballoc if the nightly feature is enabled.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.