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: NoUninit` types, unlike the standard library which only provides a few fixed atomic types (`AtomicBool`, `AtomicIsize`, `AtomicUsize`, `AtomicPtr`). The `NoUninit` bound is from the [bytemuck] crate, and indicates that a type has no internal padding bytes. You will need to derive or implement this trait for all types used with `Atomic<T>`.
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[bytemuck]: https://docs.rs/bytemuck
13
14[Documentation](https://docs.rs/atomic)
15
16## Usage
17
18Add this to your `Cargo.toml`:
19
20```toml
21[dependencies]
22atomic = "0.6"
23```
24
25and this to your crate root:
26
27```rust
28extern crate atomic;
29```
30
31## License
32
33Licensed under either of
34
35 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
36 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
37
38at your option.
39
40### Contribution
41
42Unless you explicitly state otherwise, any contribution intentionally submitted
43for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
44additional terms or conditions.
45
){kind=link}
){kind=link}