GitHub - Amanieu/atomic-rs: Generic Atomic type for Rust (original) (raw)

Generic `Atomic<T>` for Rust

A 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>.

This 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.

This crate uses #![no_std] and only depends on libcore.

Documentation

Features

This crate has the following Cargo features:

fallback: Fall back to locks when atomic instructions cannot be used. (Enabled by default.)
serde: Enables serialization and serialization of Atomic<T> withserde.

Usage

Add this to your Cargo.toml:

[dependencies] atomic = "0.6"

and this to your crate root:

License

Licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution