Struct Relation 

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

Represents a relationship between entities with associated metadata (payload).

Implementations

impl<T: Component> Relation<T>

pub fn install_to_registry(registry: &mut Registry)

Installs the relation type into the provided registry for entity processing.

pub fn register_to_processor(processor: &mut WorldProcessor)

Registers relation-specific entity remapping and inspection logic with the processor.

pub fn register_to_processor_debug(processor: &mut WorldProcessor)

where T: Debug,

Registers debug-specific formatting for this relation in the processor.

pub fn new(payload: T, entity: Entity) -> Self

Creates a new relation with a single connection.

pub fn with(self, payload: T, entity: Entity) -> Self

Adds a connection to the relation and returns the modified relation.

pub fn type_hash(&self) -> TypeHash

Returns the hash for the type of the payload.

pub fn len(&self) -> usize

Returns the number of connections in the relation.

pub fn is_empty(&self) -> bool

Checks if the relation has no connections.

pub fn add(&mut self, payload: T, entity: Entity)

Adds a connection to the relation, updating or inserting as necessary.

pub fn remove(&mut self, entity: Entity)

Removes a connection associated with an entity.

pub fn clear(&mut self)

Clears all stored relations.

pub fn has(&self, entity: Entity) -> bool

Checks if the relation has a connection with the given entity.

pub fn payload(&self, entity: Entity) -> Option<&T>

Gets the payload associated with the given entity.

pub fn payload_mut(&mut self, entity: Entity) -> Option<&mut T>

Gets a mutable reference to the payload associated with the given entity.

pub fn entities(&self) -> impl Iterator<Item = Entity> + '_

Returns an iterator over all entities in the relation.

pub fn iter(&self) -> impl Iterator<Item = (&T, Entity)>

Returns an iterator over all payload-entity pairs in the relation.

pub fn iter_mut(&mut self) -> impl Iterator<Item = (&mut T, Entity)>

Returns a mutable iterator over all payload-entity pairs in the relation.

Trait Implementations

impl<T: Clone + Component> Clone for Relation<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Component> Debug for Relation<T>

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

Formats the value using the given formatter.

impl<T: Component> Default for Relation<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Ord + Component> Ord for Relation<T>

fn cmp(&self, other: &Relation<T>) -> 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> PartialEq for Relation<T>

fn eq(&self, other: &Relation<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: PartialOrd + Component> PartialOrd for Relation<T>

fn partial_cmp(&self, other: &Relation<T>) -> 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: Eq + Component> Eq for Relation<T>

impl<T: Component> StructuralPartialEq for Relation<T>