Struct MsgAll

Source

pub struct MsgAll<'a> { /* private fields */ }

Implementations§

Source §

impl<'a> MsgAll<'a>

Source

pub const fn new(value: &'a mut MessageStorage) -> Self

Methods from Deref<Target = MessageStorage>§

Source

pub fn register_message_type<M>(&mut self)
where M: Message,

Registers a new message type within the storage.

§Type Parameters

M - The message type to register.

§Example

use limnus_message::prelude::*;

#[derive(Message, Debug, Copy, Clone)]
struct MyMessage;

let mut storage = MessageStorage::new();

storage.register_message_type::<MyMessage>();

Source

pub fn get_mut<M>(&mut self) -> Option<&mut Messages<M>>
where M: Message,

Retrieves a mutable reference to the Messages<M> container for the specified message type.

Returns None if the message type has not been registered.

§Type Parameters

M - The message type to retrieve.

§Example

use limnus_message::prelude::*;

#[derive(Message, Debug, Copy, Clone)]
struct MyMessage;

let mut storage = MessageStorage::new();

if let Some(messages) = storage.get_mut::<MyMessage>() {
    // Use `messages` here
}

Source

pub fn get<M>(&self) -> Option<&Messages<M>>
where M: Message,

Retrieves an immutable reference to the Messages<M> container for the specified message type.

Returns None if the message type has not been registered.

§Type Parameters

M - The message type to retrieve.

§Example

use limnus_message::prelude::*;

#[derive(Message, Debug, Copy, Clone)]
struct MyMessage;

let mut storage = MessageStorage::new();

if let Some(messages) = storage.get::<MyMessage>() {
    // Use `messages` here
}

Source

pub fn swap_all(&mut self)

Swaps the current and previous frame message lists for all registered message types.

This should be called at the start of each new frame to transition messages appropriately.

Note: The order in which message queues are swapped is not deterministic due to the nature of HashMap. This is generally acceptable but should be considered if order matters.

Source

pub fn send<M>(&mut self, message: M) -> MessageId<M>
where M: Message,

Sends a message of a specific type.

This method abstracts over the message type, automatically handling registration if necessary.

§Type Parameters

M - The message type to send.

§Arguments

message - The message to be sent.

§Returns

A MessageId uniquely identifying the sent message.

§Example

use limnus_message::prelude::*;

#[derive(Message, Debug, Copy, Clone)]
struct MyMessage;

let mut storage = MessageStorage::new();

let msg_id = storage.send(MyMessage { /* fields */ });

Source

pub fn iter_current<M>(&self) -> Option<MessagesIterator<'_, M>>
where M: Message,

Iterates over all messages of a specific type in the current frame.

§Type Parameters

M - The message type to iterate over.

§Returns

An iterator over references to messages of type M in the current frame.

§Example

use limnus_message::prelude::*;

#[derive(Message, Debug, Copy, Clone)]
struct MyMessage;

let mut storage = MessageStorage::new();

for message in storage.iter_current::<MyMessage>() {
    // Process `message`
}

Source

pub fn iter_previous<M>(&self) -> Option<MessagesIterator<'_, M>>
where M: Message,

Iterates over all messages of a specific type in the previous frame.

§Type Parameters

M - The message type to iterate over.

§Returns

An iterator over references to messages of type M in the previous frame.

§Example

use limnus_message::prelude::*;

#[derive(Message, Debug, Copy, Clone)]
struct MyMessage;

let mut storage = MessageStorage::new();

for message in storage.iter_previous::<MyMessage>() {
    // Process `message`
}