Struct Insert

#[repr(transparent)]
pub struct Insert<C>(pub C);

A TargetedEvent which adds component C on an entity when sent. If the entity already has the component, then the component is replaced.

Any handler which listens for Insert<C> will run before the component is inserted. Insert<C> has no effect if the target entity does not exist or the event is consumed before it finishes broadcasting.

Tuple Fields

0: C

Trait Implementations

impl<C> Clone for Insert<C>

where C: Clone,

fn clone(&self) -> Insert<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> Debug for Insert<C>

where C: Debug,

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

Formats the value using the given formatter.

impl<C> Deref for Insert<C>

type Target = C

The resulting type after dereferencing.

fn deref(&self) -> &<Insert<C> as Deref>::Target

Dereferences the value.

impl<C> DerefMut for Insert<C>

fn deref_mut(&mut self) -> &mut <Insert<C> as Deref>::Target

Mutably dereferences the value.

impl<C> Event for Insert<C>

where C: Component,

type This<'a> = Insert<C>

The type of Self, but with lifetimes modified to outlive 'a.

type EventIdx = TargetedEventIdx

Either GlobalEventIdx or TargetedEventIdx. This indicates if the event is global or targeted.

type Mutability = Mutable

Indicates if this event is Mutable or Immutable.

fn init(world: &mut World) -> EventKind

Gets the EventKind of this event and performs any necessary initialization work.

impl<C> Hash for Insert<C>

where C: Hash,

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<C> Ord for Insert<C>

where C: Ord,

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

where C: PartialEq,

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

where C: PartialOrd,

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

where C: Copy,

impl<C> Eq for Insert<C>

where C: Eq,

impl<C> StructuralPartialEq for Insert<C>