Struct ttmap::TypeMap

source ·
pub struct TypeMap { /* private fields */ }
Expand description

Type-safe store, indexed by types.

Implementations§

source§

impl TypeMap

source

pub fn new() -> Self

Creates new instance

source

pub fn len(&self) -> usize

Returns number of key & value pairs inside.

source

pub fn capacity(&self) -> usize

Returns number of key & value pairs inside.

source

pub fn is_empty(&self) -> bool

Returns whether map is empty

source

pub fn clear(&mut self)

Removes all pairs of key & value from the map.

source

pub fn has<T: Type>(&self) -> bool

Returns whether element is present in the map.

source

pub fn contains_key<T: Type>(&self) -> bool

Returns whether element is present in the map.

source

pub fn get<T: Type>(&self) -> Option<&T>

Access element in the map, returning reference to it, if present

source

pub fn get_raw(&self, id: &TypeId) -> Option<&Value<RawType>>

Access element in the map, returning reference to it, if present

source

pub fn get_mut<T: Type>(&mut self) -> Option<&mut T>

Access element in the map, returning mutable reference to it, if present

source

pub fn get_mut_raw(&mut self, id: &TypeId) -> Option<&mut Value<RawType>>

Access element in the map, returning mutable reference to it, if present

source

pub fn get_or_default<T: Type + Default>(&mut self) -> &mut T

Access element in the map, if not present, constructs it using default value.

source

pub fn insert<T: Type>(&mut self, value: T) -> Option<Box<T>>

Insert element inside the map, returning heap-allocated old one if any

Note

Be careful when inserting without explicitly specifying type. Some special types like function pointers are impossible to infer as non-anonymous type. You should manually specify type when in doubt.

source

pub fn insert_raw<T: Type>(&mut self, value: Value<T>) -> Option<Value<T>>

Insert raw element inside the map, returning heap-allocated old one if any

source

pub fn remove_raw(&mut self, id: &TypeId) -> Option<Value<RawType>>

Attempts to remove element from the map, returning boxed Some if it is present.

source

pub fn remove<T: Type>(&mut self) -> Option<Box<T>>

Attempts to remove element from the map, returning boxed Some if it is present.

Trait Implementations§

source§

impl Debug for TypeMap

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for TypeMap

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Type for T
where T: 'static + Send + Sync,