Struct valence::ecs::component::ComponentInfo

pub struct ComponentInfo { /* private fields */ }

Stores metadata for a type of component or resource stored in a specific World.

Implementations

impl ComponentInfo

pub fn id(&self) -> ComponentId

Returns a value uniquely identifying the current component.

pub fn name(&self) -> &str

Returns the name of the current component.

pub fn type_id(&self) -> Option<TypeId>

Returns the TypeId of the underlying component type. Returns None if the component does not correspond to a Rust type.

pub fn layout(&self) -> Layout

Returns the layout used to store values of this component in memory.

pub fn drop(&self) -> Option<unsafe fn(_: OwningPtr<'_>)>

Get the function which should be called to clean up values of the underlying component type. This maps to the Drop implementation for ‘normal’ Rust components

Returns None if values of the underlying component type don’t need to be dropped, e.g. as reported by needs_drop.

pub fn storage_type(&self) -> StorageType

Returns a value indicating the storage strategy for the current component.

pub fn is_send_and_sync(&self) -> bool

Returns true if the underlying component type can be freely shared between threads. If this returns false, then extra care must be taken to ensure that components are not accessed from the wrong thread.

pub fn hooks(&self) -> &ComponentHooks

Provides a reference to the collection of hooks associated with this Component

Trait Implementations

impl Clone for ComponentInfo

fn clone(&self) -> ComponentInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentInfo

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

Formats the value using the given formatter.