Struct TypeRegistration

pub struct TypeRegistration { /* private fields */ }

Runtime storage for type metadata, registered into the TypeRegistry.

An instance of TypeRegistration can be created using the TypeRegistration::of method, but is more often automatically generated using #[derive(Reflect)] which itself generates an implementation of the GetTypeRegistration trait.

Along with the type’s TypeInfo, this struct also contains a type’s registered TypeData.

See the crate-level documentation for more information on type registration.

Example

let mut registration = TypeRegistration::of::<Option<String>>();

assert_eq!("core::option::Option<alloc::string::String>", registration.type_info().type_path());
assert_eq!("Option<String>", registration.type_info().type_path_table().short_path());

registration.insert::<ReflectDefault>(FromType::<Option<String>>::from_type());
assert!(registration.data::<ReflectDefault>().is_some())

Implementations

impl TypeRegistration

pub fn of<T: Reflect + Typed + TypePath>() -> Self

Creates type registration information for T.

pub fn type_id(&self) -> TypeId

Returns the TypeId of the type.

pub fn type_info(&self) -> &'static TypeInfo

Returns a reference to the registration’s TypeInfo

pub fn insert<T: TypeData>(&mut self, data: T)

Inserts an instance of T into this registration’s type data.

If another instance of T was previously inserted, it is replaced.

pub fn data<T: TypeData>(&self) -> Option<&T>

Returns a reference to the value of type T in this registration’s type data.

Returns None if no such value exists.

For a dynamic version of this method, see data_by_id.

pub fn data_by_id(&self, type_id: TypeId) -> Option<&dyn TypeData>

Returns a reference to the value with the given TypeId in this registration’s type data.

Returns None if no such value exists.

For a static version of this method, see data.

pub fn data_mut<T: TypeData>(&mut self) -> Option<&mut T>

Returns a mutable reference to the value of type T in this registration’s type data.

Returns None if no such value exists.

For a dynamic version of this method, see data_mut_by_id.

pub fn data_mut_by_id(&mut self, type_id: TypeId) -> Option<&mut dyn TypeData>

Returns a mutable reference to the value with the given TypeId in this registration’s type data.

Returns None if no such value exists.

For a static version of this method, see data_mut.

pub fn contains<T: TypeData>(&self) -> bool

Returns true if this registration contains the given type data.

For a dynamic version of this method, see contains_by_id.

pub fn contains_by_id(&self, type_id: TypeId) -> bool

Returns true if this registration contains the given type data with TypeId.

For a static version of this method, see contains.

pub fn len(&self) -> usize

The total count of type data in this registration.

pub fn is_empty(&self) -> bool

Returns true if this registration has no type data.

pub fn iter(&self) -> impl ExactSizeIterator<Item = (TypeId, &dyn TypeData)>

Returns an iterator over all type data in this registration.

The iterator yields a tuple of the TypeId and its corresponding type data.

pub fn iter_mut( &mut self, ) -> impl ExactSizeIterator<Item = (TypeId, &mut dyn TypeData)>

Returns a mutable iterator over all type data in this registration.

The iterator yields a tuple of the TypeId and its corresponding type data.

Trait Implementations

impl Clone for TypeRegistration

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TypeRegistration

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

Formats the value using the given formatter.