Struct rt_ref::CellRef

pub struct CellRef<'a, T>
where
    T: ?Sized + 'a,
{ /* private fields */ }

An immutable reference to data in a Cell.

Access the value via std::ops::Deref (e.g. *val)

Implementations

impl<'a, T> CellRef<'a, T>

where T: ?Sized,

pub fn try_clone(&self) -> Result<Self, RefOverflow>

Returns a clone of this CellRef.

This method allows handling of reference overflows, but:

• Having 2 billion (32-bit system) / 9 quintillion (64-bit system) references to an object is not a realistic scenario in most applications.

• Applications that hold CellRefs with an ever-increasing reference count are not supported by this library.

  Reaching isize::MAX may be possible with std::mem::forget(CellRef::clone(&r)).

pub fn map<U, F>(self, f: F) -> CellRef<'a, U>

where F: FnOnce(&T) -> &U, U: ?Sized,

Makes a new CellRef for a component of the borrowed data which preserves the existing borrow.

The Cell is already immutably borrowed, so this cannot fail.

This is an associated function that needs to be used as CellRef::map(...). A method would interfere with methods of the same name on the contents of a CellRef used through Deref. Further this preserves the borrow of the value and hence does the proper cleanup when it’s dropped.

Examples

This can be used to avoid pointer indirection when a boxed item is stored in the Cell.

use rt_ref::{Cell, CellRef};

let cb = Cell::new(Box::new(5));

// Borrowing the cell causes the `CellRef` to store a reference to the `Box`, which is a
// pointer to the value on the heap, not the actual value.
let boxed_ref: CellRef<'_, Box<usize>> = cb.borrow();
assert_eq!(**boxed_ref, 5); // Notice the double deref to get the actual value.

// By using `map` we can let `CellRef` store a reference directly to the value on the heap.
let pure_ref: CellRef<'_, usize> = CellRef::map(boxed_ref, Box::as_ref);

assert_eq!(*pure_ref, 5);

We can also use map to get a reference to a sub-part of the borrowed value.

let c = Cell::new((5, 'b'));
let b1: CellRef<'_, (u32, char)> = c.borrow();
let b2: CellRef<'_, u32> = CellRef::map(b1, |t| &t.0);
assert_eq!(*b2, 5);

Trait Implementations

impl<'a, T> Clone for CellRef<'a, T>

where T: ?Sized,

fn clone(&self) -> Self

Returns a clone of this CellRef.

Panics

Panics if the number of references is isize::MAX:

• Having 2 billion / 9 quintillion references to an object is not a realistic scenario in most applications.

• Applications that hold CellRefs with an ever-increasing reference count are not supported by this library.

  Reaching isize::MAX may be possible with std::mem::forget(CellRef::clone(&r)).

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

Performs copy-assignment from source.

impl<'a, T> Debug for CellRef<'a, T>

where T: ?Sized + 'a + Debug,

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

Formats the value using the given formatter.

impl<'a, T> Deref for CellRef<'a, T>

where T: ?Sized,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T> Drop for CellRef<'a, T>

where T: ?Sized,

fn drop(&mut self)

Executes the destructor for this type.