Trait ComponentInstance 

pub trait ComponentInstance {
    // Required methods
    fn get_instance<T>(&self, entity: Entity) -> Option<InstanceRef<'_, T>>
       where T: Component;
    fn get_instance_mut<T>(
        &mut self,
        entity: Entity,
    ) -> Option<InstanceMut<'_, T>>
       where T: Component<Mutability = Mutable>;

    // Provided methods
    fn instance<T>(&self, instance: Instance<T>) -> InstanceRef<'_, T>
       where T: Component { ... }
    fn instance_mut<T>(&mut self, instance: Instance<T>) -> InstanceMut<'_, T>
       where T: Component<Mutability = Mutable> { ... }
}

Extension trait used to get Component data from an Instance<T> via World.

Required Methods

fn get_instance<T>(&self, entity: Entity) -> Option<InstanceRef<'_, T>>

where T: Component,

Returns a reference to the given instance, if it is of Kind T.

fn get_instance_mut<T>(&mut self, entity: Entity) -> Option<InstanceMut<'_, T>>

where T: Component<Mutability = Mutable>,

Returns a mutable reference to the given instance, if it is of Kind T.

This requires T to be Mutable.

Provided Methods

fn instance<T>(&self, instance: Instance<T>) -> InstanceRef<'_, T>

where T: Component,

Returns a reference to the given instance.

Panics

If the given instance is not a valid entity of kind T.

fn instance_mut<T>(&mut self, instance: Instance<T>) -> InstanceMut<'_, T>

where T: Component<Mutability = Mutable>,

Returns a mutable reference to the given instance.

This requires T to be Mutable.

Panics

If the given instance is not a valid entity of kind T.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl ComponentInstance for DeferredWorld<'_>

fn get_instance<T>(&self, entity: Entity) -> Option<InstanceRef<'_, T>>

where T: Component,

fn get_instance_mut<T>(&mut self, entity: Entity) -> Option<InstanceMut<'_, T>>

where T: Component<Mutability = Mutable>,

impl ComponentInstance for World

fn get_instance<T>(&self, entity: Entity) -> Option<InstanceRef<'_, T>>

where T: Component,

fn get_instance_mut<T>(&mut self, entity: Entity) -> Option<InstanceMut<'_, T>>

where T: Component<Mutability = Mutable>,

Implementors