Struct ComponentDescriptor

pub struct ComponentDescriptor { /* private fields */ }

A value describing a component or resource, which may or may not correspond to a Rust type.

Implementations

impl ComponentDescriptor

pub fn new<T: Component>() -> Self

Create a new ComponentDescriptor for the type T.

pub unsafe fn new_with_layout( name: impl Into<Cow<'static, str>>, storage_type: StorageType, layout: Layout, drop: Option<for<'a> unsafe fn(_: OwningPtr<'a>)>, ) -> Self

Create a new ComponentDescriptor.

Safety

• the drop fn must be usable on a pointer with a value of the layout layout
• the component type must be safe to access from any thread (Send + Sync in rust terms)

pub fn new_resource<T: Resource>() -> Self

Create a new ComponentDescriptor for a resource.

The StorageType for resources is always StorageType::Table.

pub fn storage_type(&self) -> StorageType

Returns a value indicating the storage strategy for 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 name(&self) -> &str

Returns the name of the current component.

Trait Implementations

impl Clone for ComponentDescriptor

fn clone(&self) -> ComponentDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentDescriptor

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

Formats the value using the given formatter.