Struct ComponentsQueuedRegistrator

pub struct ComponentsQueuedRegistrator<'w> { /* private fields */ }

A type that enables queuing registration in Components.

Note

These queued registrations return ComponentIds. These ids are not yet valid, but they will become valid when either ComponentsRegistrator::apply_queued_registrations is called or the same registration is made directly. In either case, the returned ComponentIds will be correct, but they are not correct yet.

Generally, that means these ComponentIds can be safely used for read-only purposes. Modifying the contents of the world through these ComponentIds directly without waiting for them to be fully registered and without then confirming that they have been fully registered is not supported. Hence, extra care is needed with these ComponentIds to ensure all safety rules are followed.

As a rule of thumb, if you have mutable access to ComponentsRegistrator, prefer to use that instead. Use this only if you need to know the id of a component but do not need to modify the contents of the world based on that id.

Implementations

impl<'w> ComponentsQueuedRegistrator<'w>

pub unsafe fn new( components: &'w Components, ids: &'w ComponentIds, ) -> ComponentsQueuedRegistrator<'w>

Constructs a new ComponentsQueuedRegistrator.

Safety

The Components and ComponentIds must match. For example, they must be from the same world.

pub fn queue_register_component<T>(&self) -> ComponentId

where T: Component,

This is a queued version of ComponentsRegistrator::register_component. This will reserve an id and queue the registration. These registrations will be carried out at the next opportunity.

If this has already been registered or queued, this returns the previous ComponentId.

Note

Technically speaking, the returned ComponentId is not valid, but it will become valid later. See type level docs for details.

pub fn queue_register_component_with_descriptor( &self, descriptor: ComponentDescriptor, ) -> ComponentId

This is a queued version of ComponentsRegistrator::register_component_with_descriptor. This will reserve an id and queue the registration. These registrations will be carried out at the next opportunity.

Note

Technically speaking, the returned ComponentId is not valid, but it will become valid later. See type level docs for details.

pub fn queue_register_resource<T>(&self) -> ComponentId

where T: Resource,

This is a queued version of ComponentsRegistrator::register_resource. This will reserve an id and queue the registration. These registrations will be carried out at the next opportunity.

If this has already been registered or queued, this returns the previous ComponentId.

Note

Technically speaking, the returned ComponentId is not valid, but it will become valid later. See type level docs for details.

pub fn queue_register_non_send<T>(&self) -> ComponentId

where T: Any,

This is a queued version of ComponentsRegistrator::register_non_send. This will reserve an id and queue the registration. These registrations will be carried out at the next opportunity.

If this has already been registered or queued, this returns the previous ComponentId.

Note

Technically speaking, the returned ComponentId is not valid, but it will become valid later. See type level docs for details.

pub fn queue_register_resource_with_descriptor( &self, descriptor: ComponentDescriptor, ) -> ComponentId

This is a queued version of ComponentsRegistrator::register_resource_with_descriptor. This will reserve an id and queue the registration. These registrations will be carried out at the next opportunity.

Note

Technically speaking, the returned ComponentId is not valid, but it will become valid later. See type level docs for details.

Methods from Deref<Target = Components>

pub fn len(&self) -> usize

Returns the number of components registered or queued with this instance.

pub fn is_empty(&self) -> bool

Returns true if there are no components registered or queued with this instance. Otherwise, this returns false.

pub fn num_queued(&self) -> usize

Returns the number of components registered with this instance.

pub fn any_queued(&self) -> bool

Returns true if there are any components registered with this instance. Otherwise, this returns false.

pub fn num_registered(&self) -> usize

Returns the number of components registered with this instance.

pub fn any_registered(&self) -> bool

Returns true if there are any components registered with this instance. Otherwise, this returns false.

pub fn get_info(&self, id: ComponentId) -> Option<&ComponentInfo>

Gets the metadata associated with the given component, if it is registered. This will return None if the id is not regiserted or is queued.

This will return an incorrect result if id did not come from the same world as self. It may return None or a garbage value.

pub fn get_descriptor<'a>( &'a self, id: ComponentId, ) -> Option<Cow<'a, ComponentDescriptor>>

Gets the ComponentDescriptor of the component with this ComponentId if it is present. This will return None only if the id is neither regisered nor queued to be registered.

Currently, the Cow will be Cow::Owned if and only if the component is queued. It will be Cow::Borrowed otherwise.

This will return an incorrect result if id did not come from the same world as self. It may return None or a garbage value.

pub fn get_name<'a>(&'a self, id: ComponentId) -> Option<Cow<'a, str>>

Gets the name of the component with this ComponentId if it is present. This will return None only if the id is neither regisered nor queued to be registered.

This will return an incorrect result if id did not come from the same world as self. It may return None or a garbage value.

pub unsafe fn get_info_unchecked(&self, id: ComponentId) -> &ComponentInfo

Gets the metadata associated with the given component.

Safety

id must be a valid and fully registered ComponentId.

pub fn is_id_valid(&self, id: ComponentId) -> bool

Returns true if the ComponentId is fully registered and valid. Ids may be invalid if they are still queued to be registered. Those ids are still correct, but they are not usable in every context yet.

pub fn get_valid_id(&self, type_id: TypeId) -> Option<ComponentId>

Type-erased equivalent of Components::valid_component_id().

pub fn valid_component_id<T>(&self) -> Option<ComponentId>

where T: Component,

Returns the ComponentId of the given Component type T if it is fully registered. If you want to include queued registration, see Components::component_id().

use bevy_ecs::prelude::*;

let mut world = World::new();

#[derive(Component)]
struct ComponentA;

let component_a_id = world.register_component::<ComponentA>();

assert_eq!(component_a_id, world.components().valid_component_id::<ComponentA>().unwrap())

See also

• Components::get_valid_id()
• Components::valid_resource_id()
• World::component_id()

pub fn get_valid_resource_id(&self, type_id: TypeId) -> Option<ComponentId>

Type-erased equivalent of Components::valid_resource_id().

pub fn valid_resource_id<T>(&self) -> Option<ComponentId>

where T: Resource,

Returns the ComponentId of the given Resource type T if it is fully registered. If you want to include queued registration, see Components::resource_id().

use bevy_ecs::prelude::*;

let mut world = World::new();

#[derive(Resource, Default)]
struct ResourceA;

let resource_a_id = world.init_resource::<ResourceA>();

assert_eq!(resource_a_id, world.components().valid_resource_id::<ResourceA>().unwrap())

See also

• Components::valid_component_id()
• Components::get_resource_id()

pub fn get_id(&self, type_id: TypeId) -> Option<ComponentId>

Type-erased equivalent of Components::component_id().

pub fn component_id<T>(&self) -> Option<ComponentId>

where T: Component,

Returns the ComponentId of the given Component type T.

The returned ComponentId is specific to the Components instance it was retrieved from and should not be used with another Components instance.

Returns None if the Component type has not yet been initialized using ComponentsRegistrator::register_component() or ComponentsQueuedRegistrator::queue_register_component().

use bevy_ecs::prelude::*;

let mut world = World::new();

#[derive(Component)]
struct ComponentA;

let component_a_id = world.register_component::<ComponentA>();

assert_eq!(component_a_id, world.components().component_id::<ComponentA>().unwrap())

See also

• Components::get_id()
• Components::resource_id()
• World::component_id()

pub fn get_resource_id(&self, type_id: TypeId) -> Option<ComponentId>

Type-erased equivalent of Components::resource_id().

pub fn resource_id<T>(&self) -> Option<ComponentId>

where T: Resource,

Returns the ComponentId of the given Resource type T.

The returned ComponentId is specific to the Components instance it was retrieved from and should not be used with another Components instance.

Returns None if the Resource type has not yet been initialized using ComponentsRegistrator::register_resource() or ComponentsQueuedRegistrator::queue_register_resource().

use bevy_ecs::prelude::*;

let mut world = World::new();

#[derive(Resource, Default)]
struct ResourceA;

let resource_a_id = world.init_resource::<ResourceA>();

assert_eq!(resource_a_id, world.components().resource_id::<ResourceA>().unwrap())

See also

• Components::component_id()
• Components::get_resource_id()

pub fn iter_registered(&self) -> impl Iterator<Item = &ComponentInfo>

Gets an iterator over all components fully registered with this instance.

Trait Implementations

impl<'w> Clone for ComponentsQueuedRegistrator<'w>

fn clone(&self) -> ComponentsQueuedRegistrator<'w>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for ComponentsQueuedRegistrator<'_>

type Target = Components

The resulting type after dereferencing.

fn deref(&self) -> &<ComponentsQueuedRegistrator<'_> as Deref>::Target

Dereferences the value.

impl<'w> Copy for ComponentsQueuedRegistrator<'w>