Struct BetterRefCell

pub struct BetterRefCell<T: ?Sized> { /* private fields */ }

An enhanced RefCell with double-borrowing support.

Implementations

impl<T> BetterRefCell<T>

pub const fn new(value: T) -> Self

Equivalent to RefCell::new.

pub fn into_inner(self) -> T

Equivalent to RefCell::into_inner.

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

Equivalent to RefCell::replace.

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

Equivalent to RefCell::replace_with.

pub fn swap(&self, other: &Self)

Equivalent to RefCell::swap.

impl<T: ?Sized> BetterRefCell<T>

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

Equivalent to RefCell::borrow.

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

Equivalent to RefCell::try_borrow.

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

Equivalent to RefCell::borrow_mut.

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

Equivalent to RefCell::try_borrow_mut.

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

Equivalent to RefCell::as_ptr.

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

Equivalent to RefCell::get_mut.

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

Equivalent to RefCell::try_borrow_unguarded.

impl<T: Default> BetterRefCell<T>

pub fn take(&self) -> T

Equivalent to RefCell::take.

impl<T: ?Sized> BetterRefCell<T>

pub fn unborrow<R>(&self, borrowed: &mut T, f: impl FnOnce() -> R) -> R

Temporarily re-grant exclusive access to the internal value, allowing borrow_mut/try_borrow_mut again in f.

Panics

This function panics only if any of the following conditions are violated:

1. borrowed must point to the internal value stored in self.
2. All borrow guards obtained from self within f must be dropped before f returns.

pub unsafe fn unborrow_unchecked<R>( &self, borrowed: &mut T, f: impl FnOnce() -> R, ) -> R

Temporarily re-grant exclusive access to the internal value, allowing borrow_mut/try_borrow_mut again in f.

Safety

This function is safe to call if all of the following conditions are met:

1. borrowed must point to the internal value stored in self.
2. All borrow guards obtained from self within f must be dropped before f returns.
3. Any borrow guards obtained from self outside of f must not be used within f.

pub fn unborrow_ref<R>(&self, borrowed: &T, f: impl FnOnce() -> R) -> R

Temporarily re-grant shared access to the internal value, allowing borrow/try_borrow again in f.

Panics

This function panics only if any of the following conditions are violated:

1. borrowed must point to the internal value stored in self.
2. If borrowed is (transitively) originated from RefMut, then all Refs obtained from self within f must be dropped before f returns.

pub unsafe fn unborrow_ref_unchecked<R>( &self, borrowed: &T, f: impl FnOnce() -> R, ) -> R

Temporarily re-grant shared access to the internal value, allowing borrow/try_borrow again in f.

Safety

This function is safe to call if all of the following conditions are met:

1. borrowed must point to the internal value stored in self.
2. If borrowed is (transitively) originated from RefMut, then all Refs obtained from self within f must be dropped before f returns.
3. Any borrow guards obtained from self outside of f must not be used within f.

Trait Implementations

impl<T: Clone> Clone for BetterRefCell<T>

fn clone(&self) -> Self

Equivalent to RefCell::clone.

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

Equivalent to RefCell::clone_from.

impl<T: Default> Default for BetterRefCell<T>

fn default() -> Self

Equivalent to RefCell::default.

impl<T> From<T> for BetterRefCell<T>

fn from(t: T) -> Self

Equivalent to RefCell::from.

impl<T: ?Sized + Ord> Ord for BetterRefCell<T>

fn cmp(&self, other: &Self) -> Ordering

Equivalent to RefCell::cmp.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T: ?Sized + PartialEq> PartialEq for BetterRefCell<T>

fn eq(&self, other: &Self) -> bool

Equivalent to RefCell::eq.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: ?Sized + PartialOrd> PartialOrd for BetterRefCell<T>

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

Equivalent to RefCell::partial_cmp.

fn lt(&self, other: &Self) -> bool

Equivalent to RefCell::lt.

fn le(&self, other: &Self) -> bool

Equivalent to RefCell::le.

fn gt(&self, other: &Self) -> bool

Equivalent to RefCell::gt.

fn ge(&self, other: &Self) -> bool

Equivalent to RefCell::ge.

impl<T: ?Sized + Eq> Eq for BetterRefCell<T>