Struct std::cell::Cell

1.0.0 · source ·
#[repr(transparent)]
pub struct Cell<T>where T: ?Sized,{ /* private fields */ }
Expand description

可变的内存位置。

内存布局

Cell<T> 具有与 UnsafeCell<T>](UnsafeCell#memory-layout) 相同的 [内存布局和注意事项。 特别是,这意味着 Cell<T> 与其内部类型 T 具有相同的内存表示。

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);
Run

有关更多信息,请参见 模块级文档

Implementations§

source§

impl<T> Cell<T>

const: 1.24.0 · source

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

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

Examples
use std::cell::Cell;

let c = Cell::new(5);
Run
source

pub fn set(&self, val: T)

设置包含的值。

Examples
use std::cell::Cell;

let c = Cell::new(5);

c.set(10);
Run
1.17.0 · source

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());
Run
1.17.0 · source

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);
Run
1.17.0 (const: unstable) · source

pub fn into_inner(self) -> T

解开值,消耗 cell。

Examples
use std::cell::Cell;

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

assert_eq!(five, 5);
Run
source§

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

source

pub fn get(&self) -> T

返回所包含值的副本。

Examples
use std::cell::Cell;

let c = Cell::new(5);

let five = c.get();
Run
source

pub fn update<F>(&self, f: F) -> Twhere 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);
Run
source§

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

1.12.0 (const: 1.32.0) · source

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

返回指向此 cell 中底层数据的裸指针。

Examples
use std::cell::Cell;

let c = Cell::new(5);

let ptr = c.as_ptr();
Run
1.11.0 · source

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

返回对底层数据的可变引用。

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

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

Examples
use std::cell::Cell;

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

assert_eq!(c.get(), 6);
Run
1.37.0 · source

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);
Run
source§

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

1.17.0 · source

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);
Run
source§

impl<T> Cell<[T]>

1.37.0 · source

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);
Run
source§

impl<T, const N: usize> Cell<[T; N]>

source

pub fn as_array_of_cells(&self) -> &[Cell<T>; N]

🔬This is a nightly-only experimental API. (as_array_of_cells #88248)

&Cell<[T; N]> 返回 &[Cell<T>; N]

Examples
#![feature(as_array_of_cells)]
use std::cell::Cell;

let mut array: [i32; 3] = [1, 2, 3];
let cell_array: &Cell<[i32; 3]> = Cell::from_mut(&mut array);
let array_cell: &[Cell<i32>; 3] = cell_array.as_array_of_cells();
Run

Trait Implementations§

source§

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

source§

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

返回值的副本。 Read more
source§

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

source 执行复制分配。 Read more
source§

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

source§

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

使用给定的格式化程序格式化该值。 Read more
source§

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

source§

fn default() -> Cell<T>

创建一个 Cell<T>,使用 T 的 Default 值。

1.12.0 · source§

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

source§

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

创建一个包含给定值的新 Cell<T>

1.10.0 · source§

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

source§

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

此方法返回 selfother 之间的 OrderingRead more
1.21.0 · source§

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

比较并返回两个值中的最大值。 Read more
1.21.0 · source§

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

比较并返回两个值中的最小值。 Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

将值限制在某个时间间隔内。 Read more
source§

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

source§

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

此方法测试 selfother 值是否相等,并由 == 使用。
source§

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

此方法测试 !=。 默认实现几乎总是足够的,并且不应在没有充分理由的情况下被覆盖。
1.10.0 · source§

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

source§

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

如果存在,则此方法返回 selfother 值之间的顺序。 Read more
source§

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

此方法测试的内容少于 (对于 selfother),并且由 < 操作员使用。 Read more
source§

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

此方法测试小于或等于 (对于 selfother),并且由 <= 运算符使用。 Read more
source§

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

此方法测试大于 (对于 selfother),并且由 > 操作员使用。 Read more
source§

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

此方法测试是否大于或等于 (对于 selfother),并且由 >= 运算符使用。 Read more
source§

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

source§

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

1.2.0 · source§

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

source§

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

source§

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

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for Cell<T>

§

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

§

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

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

获取 selfTypeIdRead more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

从拥有的值中一成不变地借用。 Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

从拥有的值中借用。 Read more
source§

impl<T> From<!> for T

source§

fn from(t: !) -> T

从输入类型转换为此类型。
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

返回未更改的参数。

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

调用 U::from(self)

也就是说,这种转换是 From<T> for U 实现选择执行的任何操作。

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

获得所有权后的结果类型。
source§

fn to_owned(&self) -> T

从借用的数据创建拥有的数据,通常是通过克隆。 Read more
source§

fn clone_into(&self, target: &mut T)

使用借来的数据来替换拥有的数据,通常是通过克隆。 Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

发生转换错误时返回的类型。
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

执行转换。
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

发生转换错误时返回的类型。
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

执行转换。