Struct TypeMap 

pub struct TypeMap { /* private fields */ }

A map of type identifiers to type-erased values.

Implementations

impl TypeMap

pub fn insert_value<T: Any + Send + Sync>( &mut self, value: T, ) -> Result<Option<T>, BroomdogErr>

Insert a value into the type map.

pub fn get_value<T: Any + Send + Sync>(&self) -> Result<Option<&T>, BroomdogErr>

Returns a reference to the value of the given parameterized type.

pub fn get_value_mut<T: Any + Send + Sync>( &mut self, ) -> Result<Option<&mut T>, BroomdogErr>

Returns a mutable reference to the value of the given parameterized type.

pub fn loan(&mut self, key: TypeKey) -> Result<Option<Loan>, BroomdogErr>

Indefinitely loans the typed value for sharing across threads.

Returns an error if the typed value is already exclusively loaned.

TypeMap::unify should be called before any call to TypeMap::get_value or TypeMap::get_value_mut, or those will result in an error.

Additionally, if TypeMap::loan_mut is called before the returned Loan is dropped, that call will err.

pub fn loan_mut(&mut self, key: TypeKey) -> Result<Option<LoanMut>, BroomdogErr>

Indefinitely loans the typed value for exclusive mutation.

TypeMap::unify should be called before any call to TypeMap::get_value or TypeMap::get_value_mut, or those will result in an error.

Additionally, if TypeMap::loan or TypeMap::loan_mut are called again before the returned LoanMut is dropped, those calls will err.

pub fn is_unified(&self) -> bool

Return whether all values are unified.

pub fn unify(&mut self) -> Result<(), BroomdogErr>

Attempts to unify the map, converting all loaned values back into owned values.

This must be called before using TypeMap::get_value or TypeMap::get_value_mut.

If the map fails to unify, the map will remain in a consistent state.

Trait Implementations

impl Debug for TypeMap

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

Formats the value using the given formatter.

impl Default for TypeMap

fn default() -> TypeMap

Returns the “default value” for a type.

impl Deref for TypeMap

type Target = HashMap<TypeKey, InnerLoan, BuildHasherDefault<FxHasher>>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for TypeMap

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

Mutably dereferences the value.