gecko-dev/third_party/rust/crossbeam-utils/README.md

Crossbeam Utils

This crate provides miscellaneous tools for concurrent programming:

Atomics

• AtomicCell, a thread-safe mutable memory location.^(no_std)
• AtomicConsume, for reading from primitive atomic types with "consume" ordering.^(no_std)

Thread synchronization

• Parker, a thread parking primitive.
• ShardedLock, a sharded reader-writer lock with fast concurrent reads.
• WaitGroup, for synchronizing the beginning or end of some computation.

Utilities

• Backoff, for exponential backoff in spin loops.^(no_std)
• CachePadded, for padding and aligning a value to the length of a cache line.^(no_std)
• scope, for spawning threads that borrow local variables from the stack.

Features marked with ^(no_std) can be used in no_std environments.

Usage

Add this to your Cargo.toml:

[dependencies]
crossbeam-utils = "0.7"

Next, add this to your crate:

extern crate crossbeam_utils;

Compatibility

The minimum supported Rust version is 1.28. Any change to this is considered a breaking change.

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

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.