Struct Component

pub struct Component<T: 'static> { /* private fields */ }

Component key

Implementations

impl<T: 'static> Component<T>

pub fn desc(&self) -> ComponentDesc

Returns an untyped description of the component key

impl<T> Component<T>

pub fn new(desc: ComponentDesc) -> Self

Create a component key from the untyped description

Panics

If the types do not match

pub fn as_debug<'a>(&self, value: &'a T) -> &'a dyn Debug

impl<T: ComponentValue + Default> Component<T>

pub fn with_default(&self) -> Entity

impl<T: ComponentValue> Component<T>

pub fn changed(self) -> ChangedQuery<T>

Methods from Deref<Target = ComponentDesc>

pub fn path(&self) -> String

The fully qualified component path.

pub fn path_last(&self) -> String

The last segment of the component path. Do not use this as a unique identifier; use Self::path instead.

pub fn name(&self) -> Option<String>

A human-friendly name, if available. Corresponds to the Name attribute.

pub fn description(&self) -> Option<String>

A human-friendly description, if available. Corresponds to the Description attribute.

pub fn type_name(&self) -> &'static str

pub fn type_id(&self) -> TypeId

pub fn is<T: 'static>(&self) -> bool

Returns true if the entry is of type T

pub fn has_attribute<A: ComponentAttribute>(&self) -> bool

pub fn attribute<A: ComponentAttribute>(&self) -> Option<AttributeGuard<A>>

pub fn attributes(&self) -> AttributeStoreGuard

pub fn attributes_mut(&self) -> AttributeStoreGuardMut

pub fn as_debug<'a>(&self, value: &'a dyn Any) -> &'a dyn Debug

pub fn index(&self) -> u32

pub fn from_json(&self, value: &str) -> Result<ComponentEntry, Error>

pub fn to_json(&self, value: &ComponentEntry) -> Result<String, Error>

Converts the value to json

pub fn create_buffer(&self) -> Box<dyn IComponentBuffer>

Trait Implementations

impl<T> Clone for Component<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: ComponentValue> ComponentQuery<'a> for Component<T>

type Data = &'a T

type DataMut = &'a mut T

type DataCloned = T

fn write_component_ids(&self, set: &mut ComponentSet)

fn get_change_filtered(&self, _: &mut Vec<ComponentDesc>)

fn get_data(&self, world: &'a World, acc: &EntityAccessor) -> Self::Data

fn get_data_mut(&self, world: &'a World, acc: &EntityAccessor) -> Self::DataMut

fn get_data_cloned( &self, world: &'a World, acc: &EntityAccessor, ) -> Self::DataCloned

impl<T> Debug for Component<T>

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

Formats the value using the given formatter.

impl<T: 'static> Deref for Component<T>

type Target = ComponentDesc

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, T: ComponentValue> Deserialize<'de> for Component<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: 'static> From<Component<T>> for ComponentDesc

fn from(value: Component<T>) -> Self

Converts to this type from the input type.

impl<T: 'static> From<ComponentDesc> for Component<T>

fn from(value: ComponentDesc) -> Self

Converts to this type from the input type.

impl<T: ComponentValue> Hash for Component<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Ord for Component<T>

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq<Component<T>> for ComponentDesc

fn eq(&self, other: &Component<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> PartialEq<ComponentDesc> for Component<T>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> PartialEq for Component<T>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> PartialOrd for Component<T>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: ComponentValue> Serialize for Component<T>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<T> Copy for Component<T>

impl<T> Eq for Component<T>