Struct Hub 

pub struct Hub { /* private fields */ }

Every combat this instance has in memory, and what they need: the store, the other services and the limits.

Implementations

impl Hub

pub async fn start( store: Store, listener: PgListener, sheet_sync: Option<SheetSync>, monsters: Option<Monsters>, limits: Limits, ) -> Result<Arc<Self>, Error>

Starts listening on listener for events from all instances, and the background upkeep: evicting idle combats and retrying HP write-back. Monsters are added from monsters.

pub fn store(&self) -> &Store

Where combats are kept.

pub fn limits(&self) -> &Limits

How much a campaign may keep.

pub async fn create( &self, campaign: &str, name: &str, quotas: &Quotas, ) -> Result<CombatSnapshot, ApiError>

Starts an empty combat in campaign, within its quotas.

pub async fn create_from_plan( &self, campaign: Uuid, encounter: Uuid, name: Option<&str>, quotas: &Quotas, ) -> Result<CombatSnapshot, ApiError>

Creates a combat from one of campaign’s plans, with the plan’s monsters in it, and called name or after the plan. All or nothing: if any of the monsters can’t be added, there’s no combat.

pub async fn combat(&self, id: Uuid) -> Result<Arc<LiveCombat>, ApiError>

The live combat, loading it from its log if it isn’t in memory.

pub async fn combat_in( &self, id: Uuid, campaign: Uuid, ) -> Result<Arc<LiveCombat>, ApiError>

The combat, if it belongs to campaign. Another campaign’s combat is reported as not found, so its existence isn’t revealed.

pub async fn execute( &self, id: Uuid, envelope: CommandEnvelope, claims: &Claims, ) -> Result<Outcome, ApiError>

Runs a command sent by the device claims are for. A player’s device may only change its own combatants (see player_may). What the command costs a character’s sheet is spent first (no slot left, no cast), and given back if the command is then refused.