README.md
1Generic `Atomic<T>` for Rust
2============================
3
4[](https://travis-ci.org/Amanieu/atomic-rs) [](https://crates.io/crates/atomic)
5
6A Rust library which provides a generic `Atomic<T>` type for all `T: Copy` types, unlike the standard library which only provides a few fixed atomic types (`AtomicBool`, `AtomicIsize`, `AtomicUsize`, `AtomicPtr`).
7
8This library will use native atomic instructions if possible, and will otherwise fall back to a lock-based mechanism. You can use the `Atomic::<T>::is_lock_free()` function to check whether native atomic operations are supported for a given type. Note that a type must have a power-of-2 size and alignment in order to be used by native atomic instructions.
9
10This crate uses `#![no_std]` and only depends on libcore.
11
12[Documentation](https://amanieu.github.io/atomic-rs/atomic/index.html)
13
14## Usage
15
16Add this to your `Cargo.toml`:
17
18```toml
19[dependencies]
20atomic = "0.5"
21```
22
23and this to your crate root:
24
25```rust
26extern crate atomic;
27```
28
29## License
30
31Licensed under either of
32
33 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
34 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
35
36at your option.
37
38### Contribution
39
40Unless you explicitly state otherwise, any contribution intentionally submitted
41for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
42additional terms or conditions.
43
){kind=link}
){kind=link}