| # Crossbeam Epoch |
| |
| []( |
| https://github.com/crossbeam-rs/crossbeam/actions) |
| []( |
| https://github.com/crossbeam-rs/crossbeam/tree/master/crossbeam-epoch#license) |
| []( |
| https://crates.io/crates/crossbeam-epoch) |
| []( |
| https://docs.rs/crossbeam-epoch) |
| []( |
| https://www.rust-lang.org) |
| [](https://discord.com/invite/JXYwgWZ) |
| |
| This crate provides epoch-based garbage collection for building concurrent data structures. |
| |
| When a thread removes an object from a concurrent data structure, other threads |
| may be still using pointers to it at the same time, so it cannot be destroyed |
| immediately. Epoch-based GC is an efficient mechanism for deferring destruction of |
| shared objects until no pointers to them can exist. |
| |
| Everything in this crate except the global GC can be used in `no_std` environments, provided that |
| `alloc` feature is enabled. |
| |
| ## Usage |
| |
| Add this to your `Cargo.toml`: |
| |
| ```toml |
| [dependencies] |
| crossbeam-epoch = "0.9" |
| ``` |
| |
| ## Compatibility |
| |
| Crossbeam Epoch supports stable Rust releases going back at least six months, |
| and every time the minimum supported Rust version is increased, a new minor |
| version is released. Currently, the minimum supported Rust version is 1.36. |
| |
| ## License |
| |
| 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 the work by you, as defined in the Apache-2.0 license, shall be |
| dual licensed as above, without any additional terms or conditions. |
