From 9e3c08db40b8916968b9f30096c7be3f00ce9647 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 21 Apr 2024 13:44:51 +0200 Subject: Adding upstream version 1:115.7.0. Signed-off-by: Daniel Baumann --- third_party/rust/atomic/README.md | 51 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 third_party/rust/atomic/README.md (limited to 'third_party/rust/atomic/README.md') diff --git a/third_party/rust/atomic/README.md b/third_party/rust/atomic/README.md new file mode 100644 index 0000000000..7b122167bf --- /dev/null +++ b/third_party/rust/atomic/README.md @@ -0,0 +1,51 @@ +Generic `Atomic` for Rust +============================ + +[![Build Status](https://travis-ci.org/Amanieu/atomic-rs.svg?branch=master)](https://travis-ci.org/Amanieu/atomic-rs) [![Crates.io](https://img.shields.io/crates/v/atomic.svg)](https://crates.io/crates/atomic) + +A Rust library which provides a generic `Atomic` type for all `T: Copy` types, unlike the standard library which only provides a few fixed atomic types (`AtomicBool`, `AtomicIsize`, `AtomicUsize`, `AtomicPtr`). + +This library will use native atomic instructions if possible, and will otherwise fall back to a lock-based mechanism. You can use the `Atomic::::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. + +Only a subset of native atomic operations are supported on stable Rust (types which are the same size as `AtomicUsize`), but you can use the `nightly` Cargo feature on a nightly compiler to enable the full range of native atomic instructions. The `nightly` feature also enables `const fn` constructors which allow you to initialize static atomic variables. + +This crate uses `#![no_std]` and only depends on libcore. + +[Documentation](https://amanieu.github.io/atomic-rs/atomic/index.html) + +## Usage + +Add this to your `Cargo.toml`: + +```toml +[dependencies] +atomic = "0.4" +``` + +and this to your crate root: + +```rust +extern crate atomic; +``` + +To enable nightly-only features, add this to your `Cargo.toml` instead: + +```toml +[dependencies] +atomic = {version = "0.4", features = ["nightly"]} +``` + +## 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. -- cgit v1.2.3