Struct std::cell::Cell

#[repr(transparent)]
pub struct Cell<T> where
    T: ?Sized,  { /* fields omitted */ }

可变的内存位置。

Examples

在此示例中，您可以看到 Cell<T> 启用了不可变结构体内部的可变的。 换句话说，它实现了内部可变性。

use std::cell::Cell;

struct SomeStruct {
    regular_field: u8,
    special_field: Cell<u8>,
}

let my_struct = SomeStruct {
    regular_field: 0,
    special_field: Cell::new(1),
};

let new_value = 100;

// ERROR: `my_struct` 是不可变 my_struct.regular_field =new_value;

// WORKS: 尽管 `my_struct` 是不可变的，但是 `special_field` 是 `Cell`，可以随时对其进行修改
my_struct.special_field.set(new_value);
assert_eq!(my_struct.special_field.get(), new_value);

有关更多信息，请参见 module-level documentation。

Implementations

impl<T> Cell<T>

pub const fn new(value: T) -> Cell<T>

创建一个包含给定值的新 Cell。

Examples

use std::cell::Cell;

let c = Cell::new(5);

pub fn set(&self, val: T)

设置包含的值。

Examples

use std::cell::Cell;

let c = Cell::new(5);

c.set(10);

pub fn swap(&self, other: &Cell<T>)

交换两个 Cell 的值。 与 std::mem::swap 的区别在于此函数不需要 &mut 引用。

Examples

use std::cell::Cell;

let c1 = Cell::new(5i32);
let c2 = Cell::new(10i32);
c1.swap(&c2);
assert_eq!(10, c1.get());
assert_eq!(5, c2.get());

pub fn replace(&self, val: T) -> T

用 val 替换包含的值，并返回旧的包含值。

Examples

use std::cell::Cell;

let cell = Cell::new(5);
assert_eq!(cell.get(), 5);
assert_eq!(cell.replace(10), 5);
assert_eq!(cell.get(), 10);

pub const fn into_inner(self) -> T

取消包装的值。

Examples

use std::cell::Cell;

let c = Cell::new(5);
let five = c.into_inner();

assert_eq!(five, 5);

impl<T> Cell<T> where
    T: Copy, 

pub fn get(&self) -> T

返回所包含值的副本。

Examples

use std::cell::Cell;

let c = Cell::new(5);

let five = c.get();

pub fn update<F>(&self, f: F) -> T where
    F: FnOnce(T) -> T, 

🔬 This is a nightly-only experimental API. (cell_update #50186)

使用函数更新包含的值并返回新值。

Examples

#![feature(cell_update)]

use std::cell::Cell;

let c = Cell::new(5);
let new = c.update(|x| x + 1);

assert_eq!(new, 6);
assert_eq!(c.get(), 6);

impl<T> Cell<T> where
    T: ?Sized, 

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

返回此 cell 中基础数据的裸指针。

Examples

use std::cell::Cell;

let c = Cell::new(5);

let ptr = c.as_ptr();

pub fn get_mut(&mut self) -> &mut T

返回对基础数据的可变引用。

这个调用借用 Cell 是可变的 (在编译时)，这保证了我们拥有唯一的引用。

但是要小心: 此方法要求 self 为附属 0，而使用 Cell 时通常不是这种情况。 如果您需要通过引用进行内部养性，可以考虑使用 RefCell，它通过其 borrow_mut 方法提供运行时检查的附属借用。

Examples

use std::cell::Cell;

let mut c = Cell::new(5);
*c.get_mut() += 1;

assert_eq!(c.get(), 6);

pub fn from_mut(t: &mut T) -> &Cell<T>

从 &mut T 返回 &Cell<T>

Examples

use std::cell::Cell;

let slice: &mut [i32] = &mut [1, 2, 3];
let cell_slice: &Cell<[i32]> = Cell::from_mut(slice);
let slice_cell: &[Cell<i32>] = cell_slice.as_slice_of_cells();

assert_eq!(slice_cell.len(), 3);

impl<T> Cell<T> where
    T: Default, 

pub fn take(&self) -> T

获取 cell 的值，将 Default::default() 保留在其位置。

Examples

use std::cell::Cell;

let c = Cell::new(5);
let five = c.take();

assert_eq!(five, 5);
assert_eq!(c.into_inner(), 0);

impl<T> Cell<[T]>

pub fn as_slice_of_cells(&self) -> &[Cell<T>]

从 &Cell<[T]> 返回 &[Cell<T>]

Examples

use std::cell::Cell;

let slice: &mut [i32] = &mut [1, 2, 3];
let cell_slice: &Cell<[i32]> = Cell::from_mut(slice);
let slice_cell: &[Cell<i32>] = cell_slice.as_slice_of_cells();

assert_eq!(slice_cell.len(), 3);

Trait Implementations

impl<T> Clone for Cell<T> where
    T: Copy, 

pub fn clone(&self) -> Cell<T>

返回值的副本。

fn clone_from(&mut self, source: &Self)

从 source 执行复制分配。

impl<T> Debug for Cell<T> where
    T: Copy + Debug, 

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

使用给定的格式化程序格式化该值。

impl<T> Default for Cell<T> where
    T: Default, 

pub fn default() -> Cell<T>

创建一个 Cell<T>，其 T 值为 Default。

impl<T> From<T> for Cell<T>

pub fn from(t: T) -> Cell<T>

执行转换。

impl<T> Ord for Cell<T> where
    T: Ord + Copy, 

pub fn cmp(&self, other: &Cell<T>) -> Ordering

此方法返回 self 和 other 之间的 Ordering。

#[must_use]

fn max(self, other: Self) -> Self

比较并返回两个值中的最大值。

#[must_use]

fn min(self, other: Self) -> Self

比较并返回两个值中的最小值。

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

将值限制为一定的时间间隔。

impl<T> PartialEq<Cell<T>> for Cell<T> where
    T: PartialEq<T> + Copy, 

pub fn eq(&self, other: &Cell<T>) -> bool

此方法测试 self 和 other 值是否相等，并由 == 使用。

#[must_use]

fn ne(&self, other: &Rhs) -> bool

此方法测试 !=。

impl<T> PartialOrd<Cell<T>> for Cell<T> where
    T: PartialOrd<T> + Copy, 

pub fn partial_cmp(&self, other: &Cell<T>) -> Option<Ordering>

如果存在，则此方法返回 self 和 other 值之间的顺序。

pub fn lt(&self, other: &Cell<T>) -> bool

此方法测试的内容少于 (对于 self 和 other)，并且由 < 操作员使用。

pub fn le(&self, other: &Cell<T>) -> bool

此方法测试小于或等于 (对于 self 和 other)，并且由 <= 运算符使用。

pub fn gt(&self, other: &Cell<T>) -> bool

此方法测试大于 (对于 self 和 other)，并且由 > 操作员使用。

pub fn ge(&self, other: &Cell<T>) -> bool

此方法测试是否大于或等于 (对于 self 和 other)，并且由 >= 运算符使用。

impl<T, U> CoerceUnsized<Cell<U>> for Cell<T> where
    T: CoerceUnsized<U>, 

impl<T> Eq for Cell<T> where
    T: Eq + Copy, 

impl<T> Send for Cell<T> where
    T: Send + ?Sized, 

impl<T> !Sync for Cell<T> where
    T: ?Sized,