Struct HedelCell

pub struct HedelCell<T: Debug> { /* private fields */ }

A safe custom RefCell-like cell, based on UnsafeCell, and relying on a BorrowFlag for runtime borrow checking.

Implementations

impl<T: Debug> HedelCell<T>

pub fn new(value: T) -> Self

The default constructor for HedelCell.

Example

use hedel_rs::cell::HedelCell;

fn main() {
	let cell = HedelCell::<i32>::new(67);
	println!("{:?}", cell.get());
}

pub fn try_get(&self) -> Result<RefHedel<'_, T>, HedelError>

Get a RefHedel pointing to the inner value in a HedelCell.

SAFETY: checks if a mutable borrow is active and panics. Also increments a shared reference counter.

Example

use hedel_rs::cell::HedelCell;

fn main() {
	let cell = HedelCell::<i32>::new(56);
	let borrow = cell.get();
	let borrow_2 = cell.get();
	println!("{:?}", borrow); // prints 56
}

pub fn get(&self) -> RefHedel<'_, T>

Guarantees to return RefHedel or panics!

pub fn try_get_mut<'a>(&'a self) -> Result<RefMutHedel<'a, T>, HedelError>

Get a RefMutHedel mutably pointing to the inner value in a HedelCell.

SAFETY: panics when a mutable reference is alive or when there’s one or more shared references. Also sets the flag to BorrowFlag::Exclusive.

Example

use hedel_rs::cell::HedelCell;

fn main() {
		
	let cell = HedelCell::<i32>::new(23);
	*cell.get_mut() = 36;
	let mut borrow = cell.get_mut();
	*borrow = 15;
	// this would panic
	// println!("{:?}", cell.get()); 
}

pub fn get_mut(&self) -> RefMutHedel<'_, T>

Guarantees to return RefMutHedel or panics!

pub fn into_inner(self) -> T

Consumes itself and returns the inner value

Trait Implementations

impl<T: Debug + Debug> Debug for HedelCell<T>

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

Formats the value using the given formatter.