Struct Store 

pub struct Store { /* private fields */ }

Combats, their logs and planned encounters, in Postgres.

Implementations

impl Store

pub async fn export_campaign( &self, campaign: Uuid, ) -> Result<CombatExport, ApiError>

The campaign’s combats and plans, as they are.

pub async fn import_campaign( &self, campaign: Uuid, export: &CombatExport, ) -> Result<u64, ApiError>

Takes in a campaign’s combats and plans exported elsewhere, as they were; returns how many came. All or nothing, and only while it has none here. Each combat’s log must be whole, from its creation in this campaign on; the rest follows from it.

impl Store

pub fn new(pool: PgPool) -> Self

A store in pool’s database.

pub fn pool(&self) -> &PgPool

The database.

pub async fn begin(&self) -> Result<Tx, ApiError>

Starts a transaction.

pub async fn create( &self, campaign: &str, name: &str, setup: Vec<CombatEvent>, ) -> Result<Uuid, ApiError>

Creates a combat whose log starts with a Created event, followed by setup (a plan’s monsters, say), all at once.

pub async fn count(&self, campaign: &str) -> Result<i64, ApiError>

How many combats campaign keeps.

pub async fn list( &self, filter: &ListFilter, ) -> Result<Vec<CombatSummary>, ApiError>

Most recently active first.

pub async fn events( &self, id: Uuid, after: u64, ) -> Result<Option<Vec<LoggedEvent>>, ApiError>

The combat’s log from after + 1 onwards, or None if there’s no such combat.

pub async fn delete_campaign(&self, campaign: &str) -> Result<u64, ApiError>

Deletes every combat of a campaign, logs and all; returns how many there were. (Its planned encounters go too.)

pub async fn events_for_command( &self, id: Uuid, command_id: Uuid, ) -> Result<Vec<LoggedEvent>, ApiError>

The events a given command produced.

pub async fn lock(&self, tx: &mut Tx, id: Uuid) -> Result<Option<u64>, ApiError>

Locks the combat until tx ends, so no other command (on any instance) can append in the meantime. Returns the latest seq, or None if there’s no such combat.

pub async fn events_in( &self, tx: &mut Tx, id: Uuid, after: u64, ) -> Result<Vec<LoggedEvent>, ApiError>

A combat’s events after after, inside tx.

pub async fn record_command( &self, tx: &mut Tx, id: Uuid, command_id: Uuid, actor_key: &str, ) -> Result<bool, ApiError>

Records that a command sent by the device with actor_key is being applied. false if it already was.

pub async fn commands_by( &self, tx: &mut Tx, id: Uuid, actor_key: &str, ) -> Result<HashSet<Uuid>, ApiError>

The commands to this combat sent by the device with actor_key.

pub async fn append( &self, tx: &mut Tx, id: Uuid, events: &[LoggedEvent], state: &CombatState, ) -> Result<(), ApiError>

Appends events (non-empty, continuing the log), refreshes the summary and announces them on CHANNEL once tx commits.

Trait Implementations

impl Clone for Store

fn clone(&self) -> Store

Returns a duplicate of the value.

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

Performs copy-assignment from source.