Struct SimpleHolder

pub struct SimpleHolder<V>(/* private fields */);

A Holder that lends its inner value itself by cloning.

Implementations

impl<V: Clone> SimpleHolder<V>

pub fn new(value: V) -> Self

pub fn into_value(self) -> V

Methods from Deref<Target = Holder<V, V, V>>

pub fn get_fn_imm(&self) -> fn(&V) -> BI

Returns immutable borrow function that you inserted at Holder::new.

pub fn get_fn_mut(&self) -> fn(&mut V) -> BM

Returns mutable borrow function that you inserted at Holder::new.

pub fn borrow(&self) -> BorrowResult<BI>

Borrows inner value.

If check feature is enabled, runtime borrow checker works and blocks try borrowing value after mutable borrow.

Examples

use my_ecs::ds::Holder;

let holder = unsafe { Holder::new(0, |v| v, |v| v) };
assert_eq!(*holder.borrow().unwrap(), &0);

pub fn borrow_mut(&mut self) -> BorrowResult<BM>

Borrows inner value mutably.

If check feature is enabled, runtime borrow checker works and blocks try borrowing value after mutable or immutable borrow.

Examples

use my_ecs::ds::Holder;

let mut holder = unsafe { Holder::new(0, |v| v, |v| v) };
**holder.borrow_mut().unwrap() = 1;
assert_eq!(*holder.borrow().unwrap(), &1);

pub fn get(&self) -> BorrowResult<&V>

Returns shared reference to the inner value without calling immutable borrow function that you inserted at Holder::new.

If check feature is enabled, runtime borrow checker works and blocks try borrowing value after mutable borrow.

Examples

use my_ecs::ds::Holder;

let holder = unsafe { Holder::new(0, |v| *v + 1, |v| *v + 1) };
let value = holder.get().unwrap();
assert_eq!(*value, &0); // Due to bypassed borrow function.

pub fn get_mut(&mut self) -> BorrowResult<&mut V>

Returns mutable reference to the inner value without calling mutable borrow function that you inserted at Holder::new.

If check feature is enabled, runtime borrow checker works and blocks try borrowing value after mutable or immutable borrow.

Examples

use my_ecs::ds::Holder;

let mut holder = unsafe { Holder::new(0, |v| *v + 1, |v| *v + 1) };
let value = holder.get_mut().unwrap();
assert_eq!(*value, &mut 0); // Due to bypassed borrow function.

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

Returns shared reference to inner value without borrow check.

Safety

Undefined behavior if exclusive borrow happened before.

Examples

use my_ecs::ds::Holder;

let holder = unsafe { Holder::new(0, |v| v, |v| v) };
let value = unsafe { holder.get_unchecked() };
assert_eq!(value, &0);

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

Returns mutable reference to inner value without borrow check.

Safety

Undefined behavior if exclusive borrow happened before.

Examples

use my_ecs::ds::Holder;

let mut holder = unsafe { Holder::new(0, |v| v, |v| v) };
let value = unsafe { holder.get_unchecked_mut() };
assert_eq!(value, &0);

pub fn borrow_count(&self) -> i32

Returns current reference count.

Returning reference count will be

• Greater than zero meaning there exist immutable borrow at the time.
• Lesser than zero meaning there exist mutable borrow at the time.
• Zero meaning no borrow at the time or check feature is disabled.

Trait Implementations

impl<V: Debug> Debug for SimpleHolder<V>

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

Formats the value using the given formatter.

impl<V> Deref for SimpleHolder<V>

type Target = Holder<V, V, V>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<V> DerefMut for SimpleHolder<V>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.