Struct SelfRefCell 

pub struct SelfRefCell<T: PointerRecomposition, I: Offset = isize> { /* private fields */ }

Container that provides safe access to a self-referenced value.

Implementations

impl<T: PointerRecomposition, I: Offset + Nullable> SelfRefCell<T, I>

pub fn new(value: T) -> Result<Self, I::Error>

Creates a new cell.

Parameters

• value - Value to be owned by the cell and referenced internally.

Returns

• Result<Self, I::Error> - Ok with an initialised cell, or the offset error when I cannot encode the distance.

pub fn get(&self) -> &T

Immutable access to the value.

Returns

• &T - Shared reference to the stored value.

pub fn try_get(&self) -> Option<&T>

Immutable access to the value if the pointer has been initialised.

Returns

• Option<&T> - Shared reference when the pointer is ready.

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

Mutable access to the value.

Returns

• &mut T - Exclusive reference to the stored value.

pub fn try_get_mut(&mut self) -> Option<&mut T>

Mutable access to the value if the pointer has been initialised.

Returns

• Option<&mut T> - Exclusive reference when the pointer is ready.

pub fn into_inner(self) -> T

Consumes the cell and returns the value.

Returns

• T - The owned value.