Struct EventKey 

pub struct EventKey(/* private fields */);

A unique identifier for an Event, used by observers.

You can look up the key for your event by calling the World::event_key method.

For dynamic events not backed by a Rust type, create an EventKey from a ComponentId using EventKey::new. Obtain a ComponentId via World::register_component_with_descriptor.

Implementations

impl EventKey

pub const unsafe fn new(component_id: ComponentId) -> Self

Creates a new EventKey from a ComponentId.

Useful for dynamic events not backed by a Rust type. Obtain a ComponentId via World::register_component_with_descriptor.

Safety

The caller must ensure that component_id was registered for use as an event (e.g. via World::register_component_with_descriptor). Using an unrelated ComponentId may cause observers to receive data with an unexpected layout.

pub const fn component_id(self) -> ComponentId

Returns the underlying ComponentId for this event key.

Trait Implementations

impl Clone for EventKey

fn clone(&self) -> EventKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EventKey

impl Debug for EventKey

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

Formats the value using the given formatter.

impl Eq for EventKey

impl Hash for EventKey

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 Ord for EventKey

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

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

fn partial_cmp(&self, other: &EventKey) -> 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 StructuralPartialEq for EventKey