Struct Component

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

Defines a strongly typed component.

Implements a read only fetch when used as part of a query

Use .as_mut() to acquire a mutable fetch.

Implementations

impl<T: ComponentValue> Component<T>

pub fn key(&self) -> ComponentKey

Get the component’s id.

pub fn id(&self) -> Entity

Get the component’s base id. This is the id without any relation target

pub fn desc(self) -> ComponentDesc

Returns the type erased component description

pub const fn as_mut(self) -> Mutable<T>

Transform this into a mutable fetch

pub fn maybe_mut(self) -> MaybeMut<T>

Transform this into a (maybe) mutable fetch

pub fn into_change_filter(self, kind: ChangeKind) -> ChangeFilter<T>

Construct a fine grained change detection filter.

Prefer TransformFetch if not in a const context

pub fn without(self) -> Without

Construct a new filter yielding entities without this component.

pub fn with(self) -> With

Construct a new filter yielding entities with this component.

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

Get the component’s name.

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<T> Debug for Component<T>

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

Formats the value using the given formatter.

impl<T> Display for Component<T>

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

Formats the value using the given formatter.

impl<'w, T> Fetch<'w> for Component<T>

where T: ComponentValue,

const MUTABLE: bool = false

true if the fetch mutates any component and thus needs a change event

type Prepared = ReadComponent<'w, T>

The prepared version of the fetch

fn prepare(&self, data: FetchPrepareData<'w>) -> Option<Self::Prepared>

Prepares the fetch for an archetype by acquiring borrows.

fn filter_arch(&self, data: FetchAccessData<'_>) -> bool

Returns true if the archetype matches the fetch

fn access(&self, data: FetchAccessData<'_>, dst: &mut Vec<Access>)

Returns which components and how will be accessed for an archetype.

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

Describes the fetch in a human-readable fashion

fn searcher(&self, searcher: &mut ArchetypeSearcher)

Returns the required component for the fetch.

fn by_ref(&self) -> RefFetch<'_, Self>

where Self: Sized,

Convert the fetch to a reference type which works with HRTB

impl<'q, T: ComponentValue> FetchItem<'q> for Component<T>

type Item = &'q T

The item yielded by the prepared fetch

impl<T: ComponentValue> From<Component<T>> for ComponentDesc

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

Converts to this type from the input type.

impl<T: ComponentValue> From<Component<T>> for Entity

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

Converts to this type from the input type.

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

fn attach(desc: ComponentDesc, buffer: &mut ComponentBuffer)

Attach the metadata to the component buffer

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: ComponentValue> RelationExt<T> for Component<T>

fn id(&self) -> Entity

Returns the relation id

fn of(&self, target: Entity) -> Component<T>

Instantiate the relation

fn with_relation(self) -> WithRelation

Construct a new filter yielding entities with this kind of relation

fn without_relation(self) -> WithoutRelation

Construct a new filter yielding entities without this kind of relation

fn vtable(&self) -> &'static UntypedVTable

Returns the vtable of the relation

fn as_relation(&self) -> Relation<T>

Convert this into a concrete relation representation

fn nth_relation(self, n: usize) -> NthRelation<T>

where Self: Sized,

Query the nth relation of the specified kind.

fn first_relation(self) -> NthRelation<T>

where Self: Sized,

Query the first relation of the specified kind.

impl<T: ComponentValue> TransformFetch<Added> for Component<T>

type Output = ChangeFilter<T>

The transformed type.

fn transform_fetch(self, _: Added) -> Self::Output

Transform the fetch using the provided method

impl<T: ComponentValue> TransformFetch<Modified> for Component<T>

type Output = ChangeFilter<T>

The transformed type.

fn transform_fetch(self, _: Modified) -> Self::Output

Transform the fetch using the provided method

impl<T> Copy for Component<T>

impl<T> Eq for Component<T>