Module sync/atomic
sync/atomic
High-level Atomic* wrappers for thread-safe shared mutable values.
Types
AtomicBool
atomic object
AtomicBool
Fields
| Name | Type | Description |
|---|---|---|
* | atomic_bool |
impl(AtomicBool, ...)
new : (AtomicBool) fn(value : bool) -> AtomicBoolload : (AtomicBool) fn(self : AtomicBool, order : MemoryOrder) -> boolstore : (AtomicBool) fn(self : AtomicBool, value : bool, order : MemoryOrder) -> unitswap : (AtomicBool) fn(self : AtomicBool, value : bool, order : MemoryOrder) -> boolcompare_exchange : (AtomicBool) fn(self : AtomicBool, expected : bool, new_value : bool, success : MemoryOrder, failure : MemoryOrder) -> boolParameters
| Name | Type | Notes |
|---|---|---|
self | AtomicBool | |
expected | bool | |
new_value | bool | |
success | MemoryOrder | |
failure | MemoryOrder |
Returns: bool
AtomicI8
atomic object
AtomicI8
Fields
| Name | Type | Description |
|---|---|---|
* | atomic_schar |
impl(AtomicI8, ...)
new : (AtomicI8) fn(value : i8) -> AtomicI8load : (AtomicI8) fn(self : AtomicI8, order : MemoryOrder) -> i8store : (AtomicI8) fn(self : AtomicI8, value : i8, order : MemoryOrder) -> unitswap : (AtomicI8) fn(self : AtomicI8, value : i8, order : MemoryOrder) -> i8compare_exchange : (AtomicI8) fn(self : AtomicI8, expected : i8, new_value : i8, success : MemoryOrder, failure : MemoryOrder) -> boolParameters
| Name | Type | Notes |
|---|---|---|
self | AtomicI8 | |
expected | i8 | |
new_value | i8 | |
success | MemoryOrder | |
failure | MemoryOrder |
Returns: bool
AtomicI16
atomic object
AtomicI16
Fields
| Name | Type | Description |
|---|---|---|
* | atomic_short |
impl(AtomicI16, ...)
new : (AtomicI16) fn(value : i16) -> AtomicI16load : (AtomicI16) fn(self : AtomicI16, order : MemoryOrder) -> i16store : (AtomicI16) fn(self : AtomicI16, value : i16, order : MemoryOrder) -> unitswap : (AtomicI16) fn(self : AtomicI16, value : i16, order : MemoryOrder) -> i16compare_exchange : (AtomicI16) fn(self : AtomicI16, expected : i16, new_value : i16, success : MemoryOrder, failure : MemoryOrder) -> boolParameters
| Name | Type | Notes |
|---|---|---|
self | AtomicI16 | |
expected | i16 | |
new_value | i16 | |
success | MemoryOrder | |
failure | MemoryOrder |
Returns: bool
AtomicI32
atomic object
AtomicI32
Fields
| Name | Type | Description |
|---|---|---|
* | atomic_int |
impl(AtomicI32, ...)
new : (AtomicI32) fn(value : i32) -> AtomicI32load : (AtomicI32) fn(self : AtomicI32, order : MemoryOrder) -> i32store : (AtomicI32) fn(self : AtomicI32, value : i32, order : MemoryOrder) -> unitfetch_add : (AtomicI32) fn(self : AtomicI32, value : i32, order : MemoryOrder) -> i32fetch_sub : (AtomicI32) fn(self : AtomicI32, value : i32, order : MemoryOrder) -> i32swap : (AtomicI32) fn(self : AtomicI32, value : i32, order : MemoryOrder) -> i32compare_exchange : (AtomicI32) fn(self : AtomicI32, expected : i32, new_value : i32, success : MemoryOrder, failure : MemoryOrder) -> boolParameters
| Name | Type | Notes |
|---|---|---|
self | AtomicI32 | |
expected | i32 | |
new_value | i32 | |
success | MemoryOrder | |
failure | MemoryOrder |
Returns: bool
AtomicI64
atomic object
AtomicI64
Fields
| Name | Type | Description |
|---|---|---|
* | atomic_llong |
impl(AtomicI64, ...)
new : (AtomicI64) fn(value : i64) -> AtomicI64load : (AtomicI64) fn(self : AtomicI64, order : MemoryOrder) -> i64store : (AtomicI64) fn(self : AtomicI64, value : i64, order : MemoryOrder) -> unitswap : (AtomicI64) fn(self : AtomicI64, value : i64, order : MemoryOrder) -> i64compare_exchange : (AtomicI64) fn(self : AtomicI64, expected : i64, new_value : i64, success : MemoryOrder, failure : MemoryOrder) -> boolParameters
| Name | Type | Notes |
|---|---|---|
self | AtomicI64 | |
expected | i64 | |
new_value | i64 | |
success | MemoryOrder | |
failure | MemoryOrder |
Returns: bool
AtomicU8
atomic object
AtomicU8
Fields
| Name | Type | Description |
|---|---|---|
* | atomic_uchar |
impl(AtomicU8, ...)
new : (AtomicU8) fn(value : u8) -> AtomicU8load : (AtomicU8) fn(self : AtomicU8, order : MemoryOrder) -> u8store : (AtomicU8) fn(self : AtomicU8, value : u8, order : MemoryOrder) -> unitswap : (AtomicU8) fn(self : AtomicU8, value : u8, order : MemoryOrder) -> u8compare_exchange : (AtomicU8) fn(self : AtomicU8, expected : u8, new_value : u8, success : MemoryOrder, failure : MemoryOrder) -> boolParameters
| Name | Type | Notes |
|---|---|---|
self | AtomicU8 | |
expected | u8 | |
new_value | u8 | |
success | MemoryOrder | |
failure | MemoryOrder |
Returns: bool
AtomicU16
atomic object
AtomicU16
Fields
| Name | Type | Description |
|---|---|---|
* | atomic_ushort |
impl(AtomicU16, ...)
new : (AtomicU16) fn(value : u16) -> AtomicU16load : (AtomicU16) fn(self : AtomicU16, order : MemoryOrder) -> u16store : (AtomicU16) fn(self : AtomicU16, value : u16, order : MemoryOrder) -> unitswap : (AtomicU16) fn(self : AtomicU16, value : u16, order : MemoryOrder) -> u16compare_exchange : (AtomicU16) fn(self : AtomicU16, expected : u16, new_value : u16, success : MemoryOrder, failure : MemoryOrder) -> boolParameters
| Name | Type | Notes |
|---|---|---|
self | AtomicU16 | |
expected | u16 | |
new_value | u16 | |
success | MemoryOrder | |
failure | MemoryOrder |
Returns: bool
AtomicU32
atomic object
AtomicU32
Fields
| Name | Type | Description |
|---|---|---|
* | atomic_uint |
impl(AtomicU32, ...)
new : (AtomicU32) fn(value : u32) -> AtomicU32load : (AtomicU32) fn(self : AtomicU32, order : MemoryOrder) -> u32store : (AtomicU32) fn(self : AtomicU32, value : u32, order : MemoryOrder) -> unitswap : (AtomicU32) fn(self : AtomicU32, value : u32, order : MemoryOrder) -> u32compare_exchange : (AtomicU32) fn(self : AtomicU32, expected : u32, new_value : u32, success : MemoryOrder, failure : MemoryOrder) -> boolParameters
| Name | Type | Notes |
|---|---|---|
self | AtomicU32 | |
expected | u32 | |
new_value | u32 | |
success | MemoryOrder | |
failure | MemoryOrder |
Returns: bool
AtomicU64
atomic object
AtomicU64
Fields
| Name | Type | Description |
|---|---|---|
* | atomic_ullong |
impl(AtomicU64, ...)
new : (AtomicU64) fn(value : u64) -> AtomicU64load : (AtomicU64) fn(self : AtomicU64, order : MemoryOrder) -> u64store : (AtomicU64) fn(self : AtomicU64, value : u64, order : MemoryOrder) -> unitswap : (AtomicU64) fn(self : AtomicU64, value : u64, order : MemoryOrder) -> u64compare_exchange : (AtomicU64) fn(self : AtomicU64, expected : u64, new_value : u64, success : MemoryOrder, failure : MemoryOrder) -> boolParameters
| Name | Type | Notes |
|---|---|---|
self | AtomicU64 | |
expected | u64 | |
new_value | u64 | |
success | MemoryOrder | |
failure | MemoryOrder |
Returns: bool
AtomicUsize
atomic object
AtomicUsize
Fields
| Name | Type | Description |
|---|---|---|
* | atomic_size_t |
impl(AtomicUsize, ...)
new : (AtomicUsize) fn(value : usize) -> AtomicUsizeload : (AtomicUsize) fn(self : AtomicUsize, order : MemoryOrder) -> usizestore : (AtomicUsize) fn(self : AtomicUsize, value : usize, order : MemoryOrder) -> unitswap : (AtomicUsize) fn(self : AtomicUsize, value : usize, order : MemoryOrder) -> usizecompare_exchange : (AtomicUsize) fn(self : AtomicUsize, expected : usize, new_value : usize, success : MemoryOrder, failure : MemoryOrder) -> boolParameters
| Name | Type | Notes |
|---|---|---|
self | AtomicUsize | |
expected | usize | |
new_value | usize | |
success | MemoryOrder | |
failure | MemoryOrder |
Returns: bool
AtomicIsize
atomic object
AtomicIsize
Fields
| Name | Type | Description |
|---|---|---|
* | atomic_ptrdiff_t |
impl(AtomicIsize, ...)
new : (AtomicIsize) fn(value : isize) -> AtomicIsizeload : (AtomicIsize) fn(self : AtomicIsize, order : MemoryOrder) -> isizestore : (AtomicIsize) fn(self : AtomicIsize, value : isize, order : MemoryOrder) -> unitswap : (AtomicIsize) fn(self : AtomicIsize, value : isize, order : MemoryOrder) -> isizecompare_exchange : (AtomicIsize) fn(self : AtomicIsize, expected : isize, new_value : isize, success : MemoryOrder, failure : MemoryOrder) -> boolParameters
| Name | Type | Notes |
|---|---|---|
self | AtomicIsize | |
expected | isize | |
new_value | isize | |
success | MemoryOrder | |
failure | MemoryOrder |
Returns: bool
MemoryOrder
enum
MemoryOrder
Variants
| Variant | Fields | Description |
|---|---|---|
Relaxed | ||
Consume | ||
Acquire | ||
Release | ||
AcqRel | ||
SeqCst |
impl(MemoryOrder, ...)
to_c_order : (MemoryOrder) fn(self : MemoryOrder) -> memory_order