Amanieu / atomic-rs

Generic Atomic<T> type for Rust

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Generic Atomic<T> for Rust

Build Status Crates.io

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

Usage

Add this to your Cargo.toml:

[dependencies]
atomic = "0.6"

and this to your crate root:

extern crate atomic;

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.

About

Generic Atomic<T> type for Rust

License:Apache License 2.0


Languages

Language:Rust 100.0%