Struct Replica 

pub struct Replica { /* private fields */ }

A client’s local copy of a combat, for optimistic UIs.

Holds the state the server has confirmed plus this client’s commands that are still in flight. Replica::state is the confirmed state with the pending commands applied on top, so a user sees the result of their action immediately. When the server’s events arrive (in its order, which may put other players’ actions first) the pending commands are replayed on top of the new confirmed state; if the server rejects one, it simply disappears from the prediction.

Contains no IO, so any frontend (native or WASM) can drive it from whatever transport it has.

Implementations

impl Replica

pub fn new(snapshot: CombatSnapshot) -> Self

A replica starting from snapshot, with nothing pending.

pub fn state(&self) -> &CombatState

What to show: the confirmed state plus this client’s pending commands.

pub fn confirmed(&self) -> &CombatState

What the server has confirmed.

pub fn seq(&self) -> u64

The last event the confirmed state includes.

pub fn pending(&self) -> &[CommandEnvelope]

Commands sent but not yet confirmed or rejected.

pub fn submit(&mut self, envelope: CommandEnvelope) -> Result<(), CombatError>

Records a command about to be sent and applies its predicted outcome. Commands that are certainly invalid fail here, instantly, and should not be sent. Commands whose outcome needs a server dice roll, and undos, are accepted but only show up once the server answers.

pub fn receive(&mut self, message: ServerMessage) -> Received

Takes in a message from the server, replaying pending commands on top of what it confirms.

Trait Implementations

impl Clone for Replica

fn clone(&self) -> Replica

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Replica

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

Formats the value using the given formatter.