Struct tuig::Replies

pub struct Replies<M: Message> { /* private fields */ }

Allows a Game or Agent to make things happen in the engine in response to messages or input.

Remember that none of these will be acted on immediately – only once the round ends.

Implementations

impl<M: Message> Replies<M>

pub fn spawn(&mut self, agent: impl Agent<M> + 'static) -> &mut Self

Have an agent spawned into the next round of messages or so.

tuig will try to spawn the agent in to the immediately next round, but that’s not always guaranteed, and in particular if the game is lagging it may be some time before new agents are spawned. If you need to ensure something happens when the agent starts, implement Agent::start. If one agent needs to synchronize with one it spawned, have the spawned agent send a “hello” message when it starts.

pub fn spawn_boxed(&mut self, agent: Box<dyn Agent<M>>) -> &mut Self

The same as Replies::spawn, but with a boxed agent.

Generally, you should use spawn; it reduces boilerplate. But if you happen to be passing around trait objects in Boxes anyway, then you should use this.

pub fn queue(&mut self, msg: M) -> &mut Self

Queues up a message to be sent out in the next round.

Queued messages are guaranteed to be processed in the next round after this one. So:

• Other running agents won’t see this message until next round
• Agents Self::spawned this round might not see it (see that method for why)

pub fn queue_all(&mut self, msgs: impl IntoIterator<Item = M>) -> &mut Self

Self::queues up several messages to be sent out in the next round.

impl<M: Message> Replies<M>

Some test-only functionality letting you introspect Replies, to test that Agents or Games are reacting properly to things that happen.

pub fn _messages(&self) -> &[M]

A test-only function, listing the messages that have been Self::queued.

pub fn _agents(&self) -> &[Box<dyn Agent<M>>]

A test-only function, listing the agents that have been Self::spawned.

Trait Implementations

impl<M: Message> Debug for Replies<M>

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

Formats the value using the given formatter.

impl<M: Message> Default for Replies<M>

fn default() -> Self

Returns the “default value” for a type.