Struct cell_family::Cell

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

A cell whose mutability is determined through its CellOwner.

Example

let cell = Cell::new(vec![1, 2, 3]);
let mut owner = CellOwner::new();

cell.get_mut(&mut owner).push(4);

assert_eq!(cell.get(&owner), &[1, 2, 3, 4]);

Implementations

impl<F: Family, T> Cell<F, T>

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

Creates a new cell which wraps the given value, and whose value can be borrowed by a CellOwner.

pub fn into_inner(self) -> T

Returns the inner value, consuming the cell.

impl<F: Family, T: ?Sized> Cell<F, T>

pub fn get<'a>(&'a self, owner: &'a CellOwner<F>) -> &'a T

Returns a reference to the underlying value of the cell, using the reference to the given CellOwner as a proof that this cell is not currently mutably borrowed.

pub unsafe fn get_unchecked(&self) -> &T

Returns a reference to the underlying value of the cell without any checks.

Safety

When calling this method, you have to ensure that the current cell (and its underlying data) is not borrowed mutably for the entire lifetime of the returned reference.

pub fn get_mut<'a>(&'a self, owner: &'a mut CellOwner<F>) -> &'a mut T

Returns a reference to the underlying value of the cell, using the reference to the given CellOwner as a proof that this cell is not currently mutably borrowed.

pub unsafe fn get_unchecked_mut(&self) -> &mut T

Returns a mutable reference to the underlying value of the cell without any checks.

Safety

When calling this method, you have to ensure that the current cell (and its underlying data) is not borrowed anywhere else for the entire lifetime of the returned reference.

pub fn clone(&self, owner: &CellOwner<F>) -> Selfwhere
    T: Clone,

Clones the inner value and returns a Cell wrapping it.

pub fn copy(&self, owner: &CellOwner<F>) -> Selfwhere
    T: Copy,

Copies the inner value and returns a Cell wrapping it.

Trait Implementations

impl<F: Family, T: Debug + ?Sized> Debug for Cell<F, T>

Simple Debug implementation for Cell.

Example

let cell = Cell::new(vec![1, 2, 3]);
let owner = CellOwner::new();

assert_eq!(format!("{cell:?}"), "Cell { family: \"Family\", .. }");

drop(owner);

assert_eq!(format!("{cell:?}"), "Cell { family: \"Family\", value: [1, 2, 3] }");

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

Formats the value using the given formatter.

impl<F: Family, T: Default> Default for Cell<F, T>

fn default() -> Self

Returns the “default value” for a type.

impl<F: Family, T> From<T> for Cell<F, T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<'a, F: Family, T: ?Sized> GetMutWithOwner<'a, F> for &'a Cell<F, T>

type GetMut = &'a mut T

The result of Self::get_mut().

fn try_get_mut(self, owner: &'a mut CellOwner<F>) -> Option<Self::GetMut>

Returns a mutable reference to the requested value(s), returning None instead if any of them is not unique (i.e. referenced by two different cells).

fn get_mut(self, owner: &'a mut CellOwner<F>) -> Self::GetMut

Same as Self::try_get_mut(), crashing on error.

impl<'a, F: Family, T: ?Sized> GetWithOwner<'a, F> for &'a Cell<F, T>

type Get = &'a T

The result of Self::get().

fn get(self, owner: &'a CellOwner<F>) -> Self::Get

Returns a reference to the requested value(s).

impl<F: ThreadSafeFamily, T: Send + Sync + ?Sized> Sync for Cell<F, T>