Struct oxygengine::prelude::TypeInfo

pub struct TypeInfo { /* private fields */ }

Metadata required to store a component.

All told, this means a TypeId, to be able to dynamically name/check the component type; a Layout, so that we know how to allocate memory for this component type; and a drop function which internally calls core::ptr::drop_in_place with the correct type parameter.

Implementations

impl TypeInfo

pub fn of<T>() -> TypeInfowhere T: 'static,

Construct a TypeInfo directly from the static type.

pub fn from_parts( id: TypeId, layout: Layout, drop: unsafe fn(_: *mut u8) ) -> TypeInfo

Construct a TypeInfo from its components. This is useful in the rare case that you have some kind of pointer to raw bytes/erased memory holding a component type, coming from a source unrelated to hecs, and you want to treat it as an insertable component by implementing the DynamicBundle API.

pub fn id(&self) -> TypeId

Access the TypeId for this component type.

pub fn layout(&self) -> Layout

Access the Layout of this component type.

pub unsafe fn drop(&self, data: *mut u8)

Directly call the destructor on a pointer to data of this component type.

Safety

All of the caveats of core::ptr::drop_in_place apply, with the additional requirement that this method is being called on a pointer to an object of the correct component type.

pub fn drop_shim(&self) -> unsafe fn(_: *mut u8)

Get the function pointer encoding the destructor for the component type this TypeInfo represents.

Trait Implementations

impl Clone for TypeInfo

fn clone(&self) -> TypeInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TypeInfo

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

Formats the value using the given formatter.

impl Ord for TypeInfo

fn cmp(&self, other: &TypeInfo) -> Ordering

Order by alignment, descending. Ties broken with TypeId.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<TypeInfo> for TypeInfo

fn eq(&self, other: &TypeInfo) -> 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 PartialOrd<TypeInfo> for TypeInfo

fn partial_cmp(&self, other: &TypeInfo) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for TypeInfo

impl Eq for TypeInfo