Struct std::cell::RefCell

pub struct RefCell<T>where
    T: ?Sized,{ /* private fields */ }

具有动态检查借用规则的可变内存位置

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

Implementations

impl<T> RefCell<T>

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

创建一个包含 value 的新 RefCell。

Examples

use std::cell::RefCell;

let c = RefCell::new(5);

pub fn into_inner(self) -> T

消耗 RefCell，返回包装的值。

Examples

use std::cell::RefCell;

let c = RefCell::new(5);

let five = c.into_inner();

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

将包装的值替换为新的值，并返回老的值，而无需对任何一个进行去初始化。

该函数对应于 std::mem::replace。

Panics

如果当前的值是借来的，就会出现 panic。

Examples

use std::cell::RefCell;
let cell = RefCell::new(5);
let old_value = cell.replace(6);
assert_eq!(old_value, 5);
assert_eq!(cell, RefCell::new(6));

pub fn replace_with<F>(&self, f: F) -> Twhere F: FnOnce(&mut T) -> T,

用从 f 计算出的新值替换包装后的值，并返回旧值，而无需对任何一个进行去初始化。

Panics

如果当前的值是借来的，就会出现 panic。

Examples

use std::cell::RefCell;
let cell = RefCell::new(5);
let old_value = cell.replace_with(|&mut old| old + 1);
assert_eq!(old_value, 5);
assert_eq!(cell, RefCell::new(6));

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

将 self 的包装值与 other 的包装值交换，而无需对任何一个进行去初始化。

该函数对应于 std::mem::swap。

Panics

如果当前借用了 RefCell 中的值，或者 self 和 other 指向相同的 RefCell，则会出现 panic。

Examples

use std::cell::RefCell;
let c = RefCell::new(5);
let d = RefCell::new(6);
c.swap(&d);
assert_eq!(c, RefCell::new(6));
assert_eq!(d, RefCell::new(5));

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

pub fn borrow(&self) -> Ref<'_, T>

不变地借用包装的值。

借用一直持续到返回的 Ref 退出作用域为止。 可以同时取出多个不可变借用。

Panics

如果当前价值是可变借来的，就会出现 panic。 对于没有 panic 的变体，请使用 try_borrow。

Examples

use std::cell::RefCell;

let c = RefCell::new(5);

let borrowed_five = c.borrow();
let borrowed_five2 = c.borrow();

panic 的一个例子：

use std::cell::RefCell;

let c = RefCell::new(5);

let m = c.borrow_mut();
let b = c.borrow(); // 这导致 panic

pub fn try_borrow(&self) -> Result<Ref<'_, T>, BorrowError>

不可变地借用包装的值，如果当前可变地借用该值，则返回错误。

借用一直持续到返回的 Ref 退出作用域为止。 可以同时取出多个不可变借用。

这是 borrow 的没有 panic 的变体。

Examples

use std::cell::RefCell;

let c = RefCell::new(5);

{
    let m = c.borrow_mut();
    assert!(c.try_borrow().is_err());
}

{
    let m = c.borrow();
    assert!(c.try_borrow().is_ok());
}

pub fn borrow_mut(&self) -> RefMut<'_, T>

可变地借用包装的值。

借用一直持续到返回的 RefMut 或从中衍生的所有 RefMut 退出作用域为止。

该借用处于活动状态时，不能借用该值。

Panics

如果当前的值是借来的，就会出现 panic。 对于没有 panic 的变体，请使用 try_borrow_mut。

Examples

use std::cell::RefCell;

let c = RefCell::new("hello".to_owned());

*c.borrow_mut() = "bonjour".to_owned();

assert_eq!(&*c.borrow(), "bonjour");

panic 的一个例子：

use std::cell::RefCell;

let c = RefCell::new(5);
let m = c.borrow();

let b = c.borrow_mut(); // 这导致 panic

pub fn try_borrow_mut(&self) -> Result<RefMut<'_, T>, BorrowMutError>

可变地借用包装的值，如果当前借用该值，则返回错误。

借用一直持续到返回的 RefMut 或从中衍生的所有 RefMut 退出作用域为止。 该借用处于活动状态时，不能借用该值。

这是 borrow_mut 的没有 panic 的变体。

Examples

use std::cell::RefCell;

let c = RefCell::new(5);

{
    let m = c.borrow();
    assert!(c.try_borrow_mut().is_err());
}

assert!(c.try_borrow_mut().is_ok());

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

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

Examples

use std::cell::RefCell;

let c = RefCell::new(5);

let ptr = c.as_ptr();

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

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

由于此方法可变地借用 RefCell，因此静态保证不存在对底层数据的借用。 因此，不需要 borrow_mut 和 RefCell 的大多数其他方法中固有的动态检查。

只有在 RefCell 可以可变借用时才能调用此方法，通常只有在创建 RefCell 后直接调用。

在这些情况下，跳过上述动态借用检查可能会产生更好的人体工程学和运行时性能。

在大多数使用 RefCell 的情况下，它不能被可变借用。 然后使用 borrow_mut 来获取对底层数据的非法访问。

Examples

use std::cell::RefCell;

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

assert_eq!(c, RefCell::new(6));

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

🔬This is a nightly-only experimental API. (cell_leak #69099)

撤消泄漏的守卫对 RefCell 借用状态的影响。

这个调用与 get_mut 类似，但更专业。 它可变地借用 RefCell 以确保不存在借用，然后重置状态跟踪共享借用。 如果某些 Ref 或 RefMut 借用已被泄露，则这是相关的。

Examples

#![feature(cell_leak)]
use std::cell::RefCell;

let mut c = RefCell::new(0);
std::mem::forget(c.borrow_mut());

assert!(c.try_borrow().is_err());
c.undo_leak();
assert!(c.try_borrow().is_ok());

pub unsafe fn try_borrow_unguarded(&self) -> Result<&T, BorrowError>

不可变地借用包装的值，如果当前可变地借用该值，则返回错误。

Safety

与 RefCell::borrow 不同，此方法是不安全的，因为它不返回 Ref，从而使借用标志保持不变。 当此方法返回的引用仍然有效时，借用 RefCell 是未定义的行为。

Examples

use std::cell::RefCell;

let c = RefCell::new(5);

{
    let m = c.borrow_mut();
    assert!(unsafe { c.try_borrow_unguarded() }.is_err());
}

{
    let m = c.borrow();
    assert!(unsafe { c.try_borrow_unguarded() }.is_ok());
}

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

pub fn take(&self) -> T

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

Panics

如果当前的值是借来的，就会出现 panic。

Examples

use std::cell::RefCell;

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

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

Trait Implementations

impl<T> Clone for RefCell<T>where T: Clone,

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

Panics

如果当前价值是可变借来的，就会出现 panic。

fn clone_from(&mut self, other: &RefCell<T>)

Panics

如果当前 other 是可变借用的，就会出现 panic。

impl<T> Debug for RefCell<T>where T: Debug + ?Sized,

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

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

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

fn default() -> RefCell<T>

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

impl<T> From<T> for RefCell<T>

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

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

impl<T> Ord for RefCell<T>where T: Ord + ?Sized,

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

Panics

如果 RefCell 中的值当前被可变地借用，则会出现 panic。

impl<T> PartialEq<RefCell<T>> for RefCell<T>where T: PartialEq<T> + ?Sized,

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

Panics

如果 RefCell 中的值当前被可变地借用，则会出现 panic。

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

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

impl<T> PartialOrd<RefCell<T>> for RefCell<T>where T: PartialOrd<T> + ?Sized,

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

Panics

如果 RefCell 中的值当前被可变地借用，则会出现 panic。

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

Panics

如果 RefCell 中的值当前被可变地借用，则会出现 panic。

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

Panics

如果 RefCell 中的值当前被可变地借用，则会出现 panic。

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

Panics

如果 RefCell 中的值当前被可变地借用，则会出现 panic。

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

Panics

如果 RefCell 中的值当前被可变地借用，则会出现 panic。

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

impl<T> Eq for RefCell<T>where T: Eq + ?Sized,

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

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