Module message

Module message 

Source
Expand description

Message functionality.

Structs§

MessageCursor
Stores the state for a MessageReader or MessageMutator.
MessageId
A MessageId uniquely identifies a message stored in a specific World.
MessageIterator
An iterator that yields any unread messages from a MessageReader or MessageCursor.
MessageIteratorWithId
An iterator that yields any unread messages (and their IDs) from a MessageReader or MessageCursor.
MessageMutIterator
An iterator that yields any unread messages from an MessageMutator or MessageCursor.
MessageMutIteratorWithId
An iterator that yields any unread messages (and their IDs) from an MessageMutator or MessageCursor.
MessageMutParIter
A parallel iterator over Messages.
MessageMutator
Mutably reads messages of type T keeping track of which messages have already been read by each system allowing multiple systems to read the same messages. Ideal for chains of systems that all want to modify the same messages.
MessageParIter
A parallel iterator over Messages.
MessageReader
Reads Messages of type T in order and tracks which messages have already been read.
MessageRegistry
A registry of all of the Messages in the World, used by message_update_system to update all of the messages.
MessageWriter
Writes Messages of type T.
Messages
A message collection that represents the messages that occurred within the last two Messages::update calls. Messages can be written to using a MessageWriter and are typically cheaply read using a MessageReader.
WriteBatchIds
Iterator over written MessageIds from a batch.

Enums§

ShouldUpdateMessages
Controls whether or not the messages in an MessageRegistry should be updated.

Traits§

Message
A buffered message for pull-based event handling.

Functions§

message_update_condition
A run condition for message_update_system.
message_update_system
A system that calls Messages::update on all registered Messages in the world.
signal_message_update_system
Signals the message_update_system to run after FixedUpdate systems.

Type Aliases§

EventUpdatesDeprecated
Deprecated alias for [MessageUpdateSystems].
SendBatchIdsDeprecated
Iterator over sent MessageIds from a batch.

Derive Macros§

Message
Implement the Message trait.