Struct core::sync::atomic::AtomicUsize

pub fn compare_and_swap( &self, current: usize, new: usize, order: Ordering ) -> usize

👎Deprecated since 1.50.0: Use compare_exchange or compare_exchange_weak instead

如果当前值与 current 值相同，则将值存储到原子整数中。

返回值始终是前一个值。如果等于 current，则该值已更新。

compare_and_swap 还带有一个 Ordering 参数，它描述了此操作的内存顺序。请注意，即使使用 AcqRel，该操作也可能失败，因此仅执行 Acquire 加载，但没有 Release 语义。

如果发生此操作，则使用 Acquire 使其成为该操作 Relaxed 的存储部分，而使用 Release 使该操作成为存储部分 Relaxed。

Note: 此方法仅在支持原子操作的平台上可用

迁移到 `compare_exchange` 和 `compare_exchange_weak`

compare_and_swap 等效于 compare_exchange，具有以下内存排序映射：

Original	Success	Failure
Relaxed	Relaxed	Relaxed Acquire

即使比较成功，compare_exchange_weak 也允许虚假失败，这允许编译器在循环中使用比较和交换时生成更好的汇编代码。

pub fn compare_exchange( &self, current: usize, new: usize, success: Ordering, failure: Ordering ) -> Result<usize, usize>

如果当前值与 current 值相同，则将值存储到原子整数中。

返回值是指示是否写入了新值并包含先前值的结果。成功后，此值保证等于 current。

compare_exchange 需要两个 Ordering 参数来描述这个操作的内存顺序。 success 描述了在与 current 的比较成功时发生的读取 - 修改 - 写入操作所需的顺序。 failure 描述了比较失败时发生的加载操作所需的排序。使用 Acquire 作为成功排序，使存储成为操作 Relaxed 的一部分，而使用 Release，则使装载成功 Relaxed。

故障顺序只能是 SeqCst、Acquire 或 Relaxed。

Note: 此方法仅在支持原子操作的平台上可用

Examples

use std::sync::atomic::{AtomicUsize, Ordering};

let some_var = AtomicUsize::new(5);

assert_eq!(some_var.compare_exchange(5, 10,
                                     Ordering::Acquire,
                                     Ordering::Relaxed),
           Ok(5));
assert_eq!(some_var.load(Ordering::Relaxed), 10);

assert_eq!(some_var.compare_exchange(6, 12,
                                     Ordering::SeqCst,
                                     Ordering::Acquire),
           Err(10));
assert_eq!(some_var.load(Ordering::Relaxed), 10);

1.10.0 · source

pub fn compare_exchange_weak( &self, current: usize, new: usize, success: Ordering, failure: Ordering ) -> Result<usize, usize>

如果当前值与 current 值相同，则将值存储到原子整数中。

Unlike AtomicUsize::compare_exchange, 即使比较成功，此函数也可能会虚假地失败，这可能导致某些平台上的代码效率更高。返回值是指示是否写入了新值并包含先前值的结果。

compare_exchange_weak 需要两个 Ordering 参数来描述这个操作的内存顺序。 success 描述了在与 current 的比较成功时发生的读取 - 修改 - 写入操作所需的顺序。 failure 描述了比较失败时发生的加载操作所需的排序。使用 Acquire 作为成功排序，使存储成为操作 Relaxed 的一部分，而使用 Release，则使装载成功 Relaxed。

故障顺序只能是 SeqCst、Acquire 或 Relaxed。

Note: 此方法仅在支持原子操作的平台上可用

Examples

use std::sync::atomic::{AtomicUsize, Ordering};

let val = AtomicUsize::new(4);

let mut old = val.load(Ordering::Relaxed);
loop {
    let new = old * 2;
    match val.compare_exchange_weak(old, new, Ordering::SeqCst, Ordering::Relaxed) {
        Ok(_) => break,
        Err(x) => old = x,
    }
}

pub fn fetch_add(&self, val: usize, order: Ordering) -> usize

加到当前值，返回前一个值。

此操作在溢出时回绕。

fetch_add 需要一个 Ordering 参数，它描述了这个操作的内存顺序。所有排序模式都是可能的。请注意，使用 Acquire 会使该操作成为存储部分 Relaxed，而使用 Release 会使装入部分成为 Relaxed。

Note: 此方法仅在支持原子操作的平台上可用

Examples

use std::sync::atomic::{AtomicUsize, Ordering};

let foo = AtomicUsize::new(0);
assert_eq!(foo.fetch_add(10, Ordering::SeqCst), 0);
assert_eq!(foo.load(Ordering::SeqCst), 10);

pub fn fetch_sub(&self, val: usize, order: Ordering) -> usize

从当前值中减去，返回前一个值。

此操作在溢出时回绕。

fetch_sub 需要一个 Ordering 参数，它描述了这个操作的内存顺序。所有排序模式都是可能的。请注意，使用 Acquire 会使该操作成为存储部分 Relaxed，而使用 Release 会使装入部分成为 Relaxed。

Note: 此方法仅在支持原子操作的平台上可用

Examples

use std::sync::atomic::{AtomicUsize, Ordering};

let foo = AtomicUsize::new(20);
assert_eq!(foo.fetch_sub(10, Ordering::SeqCst), 20);
assert_eq!(foo.load(Ordering::SeqCst), 10);

pub fn fetch_and(&self, val: usize, order: Ordering) -> usize

“and” 按位与当前值。

对当前值和参数 val 执行按位 “and” 运算，并将新值设置为结果。

返回前一个值。

fetch_and 需要一个 Ordering 参数，它描述了这个操作的内存顺序。所有排序模式都是可能的。请注意，使用 Acquire 会使该操作成为存储部分 Relaxed，而使用 Release 会使装入部分成为 Relaxed。

Note: 此方法仅在支持原子操作的平台上可用

Examples

use std::sync::atomic::{AtomicUsize, Ordering};

let foo = AtomicUsize::new(0b101101);
assert_eq!(foo.fetch_and(0b110011, Ordering::SeqCst), 0b101101);
assert_eq!(foo.load(Ordering::SeqCst), 0b100001);

1.27.0 · source

pub fn fetch_nand(&self, val: usize, order: Ordering) -> usize

“nand” 按位与当前值。

对当前值和参数 val 执行按位 “nand” 运算，并将新值设置为结果。

返回前一个值。

fetch_nand 需要一个 Ordering 参数，它描述了这个操作的内存顺序。所有排序模式都是可能的。请注意，使用 Acquire 会使该操作成为存储部分 Relaxed，而使用 Release 会使装入部分成为 Relaxed。

Note: 此方法仅在支持原子操作的平台上可用

Examples

use std::sync::atomic::{AtomicUsize, Ordering};

let foo = AtomicUsize::new(0x13);
assert_eq!(foo.fetch_nand(0x31, Ordering::SeqCst), 0x13);
assert_eq!(foo.load(Ordering::SeqCst), !(0x13 & 0x31));

pub fn fetch_or(&self, val: usize, order: Ordering) -> usize

“or” 按位与当前值。

对当前值和参数 val 执行按位 “or” 运算，并将新值设置为结果。

返回前一个值。

fetch_or 需要一个 Ordering 参数，它描述了这个操作的内存顺序。所有排序模式都是可能的。请注意，使用 Acquire 会使该操作成为存储部分 Relaxed，而使用 Release 会使装入部分成为 Relaxed。

Note: 此方法仅在支持原子操作的平台上可用

Examples

use std::sync::atomic::{AtomicUsize, Ordering};

let foo = AtomicUsize::new(0b101101);
assert_eq!(foo.fetch_or(0b110011, Ordering::SeqCst), 0b101101);
assert_eq!(foo.load(Ordering::SeqCst), 0b111111);

pub fn fetch_xor(&self, val: usize, order: Ordering) -> usize

“xor” 按位与当前值。

对当前值和参数 val 执行按位 “xor” 运算，并将新值设置为结果。

返回前一个值。

fetch_xor 需要一个 Ordering 参数，它描述了这个操作的内存顺序。所有排序模式都是可能的。请注意，使用 Acquire 会使该操作成为存储部分 Relaxed，而使用 Release 会使装入部分成为 Relaxed。

Note: 此方法仅在支持原子操作的平台上可用

Examples

use std::sync::atomic::{AtomicUsize, Ordering};

let foo = AtomicUsize::new(0b101101);
assert_eq!(foo.fetch_xor(0b110011, Ordering::SeqCst), 0b101101);
assert_eq!(foo.load(Ordering::SeqCst), 0b011110);

1.45.0 · source

pub fn fetch_update<F>( &self, set_order: Ordering, fetch_order: Ordering, f: F ) -> Result<usize, usize>where F: FnMut(usize) -> Option<usize>,

获取该值，并对其应用一个函数，该函数返回一个可选的新值。如果函数返回 Some(_)，则返回 Ok(previous_value) 的 Result，否则返回 Err(previous_value)。

Note: 如果与此同时从其他线程更改了值，则只要函数返回 Some(_)，这可能会多次调用该函数，但是该函数仅对存储的值应用一次。

fetch_update 需要两个 Ordering 参数来描述这个操作的内存顺序。第一个描述了操作最终成功时所需的顺序，第二个描述了负载所需的顺序。这些对应于成功和失败的顺序

AtomicUsize::compare_exchange respectively.

使用 Acquire 作为成功排序，使存储成为该操作 Relaxed 的一部分，而使用 Release，则使最终成功加载 Relaxed。 (failed) 加载顺序只能是 SeqCst、Acquire 或 Relaxed。

Note: 此方法仅在支持原子操作的平台上可用

Considerations

这种方法并不神奇; 它不是由硬件提供的。它是按照以下方式实现的 AtomicUsize::compare_exchange_weak, 并遭受同样的缺点。特别是，这种方法不会绕过 ABA Problem。

Examples

use std::sync::atomic::{AtomicUsize, Ordering};

let x = AtomicUsize::new(7);
assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |_| None), Err(7));
assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |x| Some(x + 1)), Ok(7));
assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |x| Some(x + 1)), Ok(8));
assert_eq!(x.load(Ordering::SeqCst), 9);

1.45.0 · source

pub fn fetch_max(&self, val: usize, order: Ordering) -> usize

当前值的最大值。

查找当前值和参数 val 的最大值，并将新值设置为结果。

返回前一个值。

fetch_max 需要一个 Ordering 参数，它描述了这个操作的内存顺序。所有排序模式都是可能的。请注意，使用 Acquire 会使该操作成为存储部分 Relaxed，而使用 Release 会使装入部分成为 Relaxed。

Note: 此方法仅在支持原子操作的平台上可用

Examples

use std::sync::atomic::{AtomicUsize, Ordering};

let foo = AtomicUsize::new(23);
assert_eq!(foo.fetch_max(42, Ordering::SeqCst), 23);
assert_eq!(foo.load(Ordering::SeqCst), 42);

如果要一步获得最大值，可以使用以下方法：

use std::sync::atomic::{AtomicUsize, Ordering};

let foo = AtomicUsize::new(23);
let bar = 42;
let max_foo = foo.fetch_max(bar, Ordering::SeqCst).max(bar);
assert!(max_foo == 42);

1.45.0 · source

pub fn fetch_min(&self, val: usize, order: Ordering) -> usize

当前值的最小值。

查找当前值和参数 val 的最小值，并将新值设置为结果。

返回前一个值。

fetch_min 需要一个 Ordering 参数，它描述了这个操作的内存顺序。所有排序模式都是可能的。请注意，使用 Acquire 会使该操作成为存储部分 Relaxed，而使用 Release 会使装入部分成为 Relaxed。

Note: 此方法仅在支持原子操作的平台上可用

Examples

use std::sync::atomic::{AtomicUsize, Ordering};

let foo = AtomicUsize::new(23);
assert_eq!(foo.fetch_min(42, Ordering::Relaxed), 23);
assert_eq!(foo.load(Ordering::Relaxed), 23);
assert_eq!(foo.fetch_min(22, Ordering::Relaxed), 23);
assert_eq!(foo.load(Ordering::Relaxed), 22);

如果要一步获得最小值，则可以使用以下方法：

use std::sync::atomic::{AtomicUsize, Ordering};

let foo = AtomicUsize::new(23);
let bar = 12;
let min_foo = foo.fetch_min(bar, Ordering::SeqCst).min(bar);
assert_eq!(min_foo, 12);

1.70.0 (const: 1.70.0) · source

pub const fn as_ptr(&self) -> *mut usize

返回指向底层整数的可变指针。

在结果整数上进行非原子读取和写入可以是数据竞争。此方法对于 FFI 最为有用，在 FFI 中可能使用函数签名 *mut usize instead of &AtomicUsize. 从共享引用返回 *mut 指针到此原子是安全的，因为原子类型可与内部可变性一起使用。原子的所有修改都通过共享的 quot 更改值，并且只要它们使用原子操作就可以安全地进行更改。对返回的裸指针的任何使用都需要一个 unsafe 块，并且仍然必须遵守相同的限制：对其进行的操作必须是原子的。

Examples

use std::sync::atomic::AtomicUsize;

extern "C" {
    fn my_atomic_op(arg: *mut usize);
}

let atomic = AtomicUsize::new(1);

// SAFETY: 只要 `my_atomic_op` 是原子的就安全。
unsafe {
    my_atomic_op(atomic.as_ptr());
}