Struct WithValue

pub struct WithValue<T, S> { /* private fields */ }

Receive the component value of an event

This is a convenience wrapper around EventSubscriber that sends the component value along

Note: This only tracks addition and removal of components, not modification. This is due to a limitation with references lifetimes during iteration, as the values can’t be accessed by the subscriber simultaneously.

Implementations

impl<T, S> WithValue<T, S>

pub fn new(component: Component<T>, sink: S) -> Self

Create a new WithValue subscriber

Trait Implementations

impl<T: ComponentValue + Clone, S: 'static + Send + Sync + Sink<(Event, T)>> EventSubscriber for WithValue<T, S>

fn on_added(&self, storage: &Storage, event: &EventData<'_>)

Handle an incoming event

fn on_modified(&self, _: &EventData<'_>)

Handle an incoming event

fn on_removed(&self, storage: &Storage, event: &EventData<'_>)

Handle an incoming event

fn is_connected(&self) -> bool

Returns true if the subscriber is still connected

fn matches_component(&self, desc: ComponentDesc) -> bool

Returns true if the subscriber is interested in this component

fn matches_arch(&self, arch: &Archetype) -> bool

Returns true if the subscriber is interested in this archetype

fn filter<F>(self, func: F) -> FilterFunc<Self, F>

where Self: Sized, F: Fn(EventKind, &EventData<'_>) -> bool,

Filter each event before it is generated through a custom function

fn filter_arch<F: StaticFilter>(self, filter: F) -> FilterArch<Self, F>

where Self: Sized,

Filter the archetypes for which the subscriber will receive events

fn filter_components<I: IntoIterator<Item = ComponentKey>>( self, components: I, ) -> FilterComponents<Self>

where Self: Sized,

Filter a subscriber to only receive events for a specific set of components

fn filter_event_kind(self, event_kind: EventKind) -> FilterEventKind<Self>

where Self: Sized,

Filter a subscriber to only receive events of a specific kind