Struct shard_ecs::descriptors::component_descriptor::ComponentDescriptor

pub struct ComponentDescriptor {
    pub component_type_id: ComponentTypeId,
    pub size: u16,
    pub align: u16,
    pub fns: ComponentDescriptorFnPointers,
}

Describes a specific component type.

Safety:

• [size] must not exceed u16::MAX.
• [align] must not exceed u16::MAX.

Fields

component_type_id: ComponentTypeId

size: u16

align: u16

fns: ComponentDescriptorFnPointers

Implementations

impl ComponentDescriptor

pub const INVALID: Self = _

Represents an invalid component descriptor. This descriptor must not be used as a valid descriptor.

pub fn new(
    component_type_id: ComponentTypeId,
    size: u16,
    align: u16,
    drop_handler: unsafe fn(ptr: *mut u8, len: usize)
) -> Self

Creates a new component descriptor from the provided arguments. Returns ComponentDescriptor::INVALID if a valid descriptor cannot be constructed.

pub unsafe fn drop_handler_wrapper<C: Component>(ptr: *mut u8, len: usize)

Do not use this manually. It wraps a type erased drop handler.

Safety

The pointer must be properly aligned to an instance of C and the len must be valid for the slice.

pub const fn component_type_id(&self) -> ComponentTypeId

Get a the component descriptor’s component type id.

pub const fn size(&self) -> u16

Get a the component descriptor’s size.

pub const fn align(&self) -> u16

Get a the component descriptor’s align.

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.

impl Into<ArchetypeDescriptor> for &ComponentDescriptor

fn into(self) -> ArchetypeDescriptor

Converts this type into the (usually inferred) input type.

impl Into<ArchetypeDescriptor> for ComponentDescriptor

fn into(self) -> ArchetypeDescriptor

Converts this type into the (usually inferred) input type.

impl PartialEq<ComponentDescriptor> for ComponentDescriptor

fn eq(&self, other: &ComponentDescriptor) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ComponentDescriptor