Struct CharacterStore 

pub struct CharacterStore { /* private fields */ }

Persistence for characters, in Postgres. Every operation is scoped to one campaign: a character of another campaign is simply not found.

Implementations

impl CharacterStore

pub fn new(pool: PgPool) -> Self

A store in pool’s database.

pub async fn list(&self, scope: Scope) -> Result<Vec<Character>, ApiError>

The campaign’s characters.

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

How many characters campaign keeps.

pub async fn get(&self, scope: Scope, id: Uuid) -> Result<Character, ApiError>

One of the campaign’s characters.

pub async fn create( &self, scope: Scope, sheet: CharacterSheet, ) -> Result<Character, ApiError>

Creates a character, played by the device creating it if that’s a player’s.

pub async fn replace( &self, scope: Scope, id: Uuid, expected_version: Option<u64>, sheet: CharacterSheet, ) -> Result<Character, ApiError>

Replaces the sheet if the stored version still equals expected_version (None skips the check). The compare and the write happen in one statement, so there’s no window for another write.

pub async fn apply( &self, scope: Scope, id: Uuid, action: &CharacterAction, key: Option<&str>, ) -> Result<Character, ApiError>

Applies action to the sheet, atomically: the character’s row stays locked until it’s written, so concurrent actions (two clients spending the same slot) take turns. With a key, only once: sent again with the same key, the character is returned as it now is.

pub async fn set_owners( &self, scope: Scope, id: Uuid, owners: &[String], ) -> Result<Character, ApiError>

Sets which player devices play the character, by key. That’s a change like any other: the version moves on.

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

Deletes every character of a campaign; returns how many there were. (Their applied actions go with them.)

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

Every character of campaign, as they are, to keep or move elsewhere.

pub async fn import_campaign( &self, campaign: Uuid, characters: &[Character], ) -> Result<u64, ApiError>

Takes in campaign’s characters exported elsewhere, as they were: ids, owners, versions and dates. All or nothing, and only while it has none here.

pub async fn delete(&self, scope: Scope, id: Uuid) -> Result<(), ApiError>

Deletes a character the device may change.

Trait Implementations

impl Clone for CharacterStore

fn clone(&self) -> CharacterStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.