Expand description
Message functionality.
Structs§
- Message
Cursor - Stores the state for a
MessageReaderorMessageMutator. - Message
Id - A
MessageIduniquely identifies a message stored in a specificWorld. - Message
Iterator - An iterator that yields any unread messages from a
MessageReaderorMessageCursor. - Message
Iterator With Id - An iterator that yields any unread messages (and their IDs) from a
MessageReaderorMessageCursor. - Message
MutIterator - An iterator that yields any unread messages from an
MessageMutatororMessageCursor. - Message
MutIterator With Id - An iterator that yields any unread messages (and their IDs) from an
MessageMutatororMessageCursor. - Message
MutPar Iter - A parallel iterator over
Messages. - Message
Mutator - Mutably reads messages of type
Tkeeping 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. - Message
ParIter - A parallel iterator over
Messages. - Message
Reader - Reads
Messages of typeTin order and tracks which messages have already been read. - Message
Registry - A registry of all of the
Messagesin theWorld, used bymessage_update_systemto update all of the messages. - Message
Writer - Writes
Messages of typeT. - Messages
- A message collection that represents the messages that occurred within the last two
Messages::updatecalls. Messages can be written to using aMessageWriterand are typically cheaply read using aMessageReader. - Write
Batch Ids Iteratorover writtenMessageIdsfrom a batch.
Enums§
- Should
Update Messages - Controls whether or not the messages in an
MessageRegistryshould 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::updateon all registeredMessagesin the world. - signal_
message_ update_ system - Signals the
message_update_systemto run afterFixedUpdatesystems.
Type Aliases§
- Event
Updates Deprecated - Deprecated alias for [
MessageUpdateSystems]. - Send
Batch Ids Deprecated Iteratorover sentMessageIdsfrom a batch.
Derive Macros§
- Message
- Implement the
Messagetrait.