Struct GlobalEventId

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

Lightweight identifier for a global event type.

Event identifiers are implemented using an index and a generation count. The generation count ensures that IDs from despawned events are not reused by new events.

An event identifier is only meaningful in the World it was created from. Attempting to use an event ID in a different world will have unexpected results.

Implementations

impl GlobalEventId

pub const NULL: GlobalEventId

The global event ID which never identifies a live entity. This is the default value for EntityId.

pub const fn new(index: u32, generation: u32) -> Option<GlobalEventId>

Creates a new entity ID from an index and generation count. Returns None if a valid ID is not formed.

pub const fn index(self) -> GlobalEventIdx

Returns the index of this ID.

pub const fn generation(self) -> u32

Returns the generation count of this ID.

Trait Implementations

impl Clone for GlobalEventId

fn clone(&self) -> GlobalEventId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalEventId

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

Formats the value using the given formatter.

impl Default for GlobalEventId

fn default() -> GlobalEventId

Returns the “default value” for a type.

impl Hash for GlobalEventId

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

where __H: Hasher,

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 GlobalEventId

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

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

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

impl Eq for GlobalEventId

impl StructuralPartialEq for GlobalEventId