Skip to main content

EventChannel

Struct EventChannel 

Source
pub struct EventChannel<T> { /* private fields */ }
Expand description

A typed event channel for game-specific events.

Games insert this as a global resource on World:

use elevator_core::world::World;
use elevator_core::events::EventChannel;

#[derive(Debug)]
enum MyGameEvent { Foo, Bar }

let mut world = World::new();
world.insert_resource(EventChannel::<MyGameEvent>::new());
// Later:
world.resource_mut::<EventChannel<MyGameEvent>>().unwrap().emit(MyGameEvent::Foo);

Implementations§

Source§

impl<T> EventChannel<T>

Source

pub const fn new() -> Self

Create an empty event channel.

Source

pub fn emit(&mut self, event: T)

Emit an event into the channel.

Source

pub fn drain(&mut self) -> Vec<T>

Drain and return all pending events.

Source

pub fn peek(&self) -> &[T]

Peek at pending events without clearing.

Source

pub const fn is_empty(&self) -> bool

Check if the channel has no pending events.

Source

pub const fn len(&self) -> usize

Number of pending events.

Trait Implementations§

Source§

impl<T: Debug> Debug for EventChannel<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Default for EventChannel<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for EventChannel<T>

§

impl<T> RefUnwindSafe for EventChannel<T>
where T: RefUnwindSafe,

§

impl<T> Send for EventChannel<T>
where T: Send,

§

impl<T> Sync for EventChannel<T>
where T: Sync,

§

impl<T> Unpin for EventChannel<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for EventChannel<T>

§

impl<T> UnwindSafe for EventChannel<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.