Struct typemap::TypeMap

pub struct TypeMap<A: ?Sized = dyn UnsafeAny> where
    A: UnsafeAnyExt,  { /* fields omitted */ }

A map keyed by types.

Can contain one value of any type for each key type, as defined by the Assoc trait.

You usually do not need to worry about the A type parameter, but it can be used to add bounds to the possible value types that can be stored in this map. Usually, you are looking for ShareMap, which is Send + Sync.

Methods

impl TypeMap

pub fn new() -> TypeMap

Create a new, empty TypeMap.

impl<A: UnsafeAnyExt + ?Sized> TypeMap<A>

pub fn custom() -> TypeMap<A>

Create a new, empty TypeMap.

Can be used with any A parameter; new is specialized to get around the required type annotations when using this function.

pub fn insert<K: Key>(&mut self, val: K::Value) -> Option<K::Value> where
    K::Value: Any + Implements<A>, 

Insert a value into the map with a specified key type.

pub fn get<K: Key>(&self) -> Option<&K::Value> where
    K::Value: Any + Implements<A>, 

Find a value in the map and get a reference to it.

pub fn get_mut<K: Key>(&mut self) -> Option<&mut K::Value> where
    K::Value: Any + Implements<A>, 

Find a value in the map and get a mutable reference to it.

pub fn contains<K: Key>(&self) -> bool

Check if a key has an associated value stored in the map.

pub fn remove<K: Key>(&mut self) -> Option<K::Value> where
    K::Value: Any + Implements<A>, 

Remove a value from the map.

Returns true if a value was removed.

pub fn entry<'a, K: Key>(&'a mut self) -> Entry<'a, K, A> where
    K::Value: Any + Implements<A>, 

Get the given key's corresponding entry in the map for in-place manipulation.

pub unsafe fn data(&self) -> &HashMap<TypeId, Box<A>>

Read the underlying HashMap

pub unsafe fn data_mut(&mut self) -> &mut HashMap<TypeId, Box<A>>

Get a mutable reference to the underlying HashMap

pub fn len(&self) -> usize

Get the number of values stored in the map.

pub fn is_empty(&self) -> bool

Return true if the map contains no values.

pub fn clear(&mut self)

Remove all entries from the map.

Trait Implementations

impl<A: Default + ?Sized> Default for TypeMap<A> where
    A: UnsafeAnyExt, 

fn default() -> TypeMap<A>

Returns the "default value" for a type.

impl<A: ?Sized> Clone for TypeMap<A> where
    A: UnsafeAnyExt,
    Box<A>: Clone, 

fn clone(&self) -> TypeMap<A>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<A: Debug + ?Sized> Debug for TypeMap<A> where
    A: UnsafeAnyExt, 

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

Formats the value using the given formatter.