Struct bevy::reflect::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 type_id(&self) -> TypeId

Returns the TypeId of the type.

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

where T: TypeData,

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

Returns None if no such value exists.

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

where T: TypeData,

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

Returns None if no such value exists.

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

Returns a reference to the registration’s TypeInfo

Examples found in repository

examples/reflection/generic_reflection.rs (line 28)

fn setup(type_registry: Res<AppTypeRegistry>) {
    let type_registry = type_registry.read();

    let registration = type_registry.get(TypeId::of::<MyType<u32>>()).unwrap();
    info!(
        "Registration for {} exists",
        registration.type_info().type_path(),
    );

    // MyType<String> was not manually registered, so it does not exist
    assert!(type_registry.get(TypeId::of::<MyType<String>>()).is_none());
}

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

where T: TypeData,

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

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

pub fn of<T>() -> TypeRegistration

where T: Reflect + Typed + TypePath,

Creates type registration information for T.

Trait Implementations

impl Clone for TypeRegistration

fn clone(&self) -> TypeRegistration

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<(), Error>

Formats the value using the given formatter.