Struct CombatClient 

pub struct CombatClient { /* private fields */ }

The combat service’s client: combats and planned encounters.

Implementations

impl CombatClient

pub fn new(base_url: impl Into<String>) -> Self

A client for the combat service at base_url, without a token.

pub fn with_token(self, token: &str) -> Self

Sends token (from crate::auth::AuthClient::login) with every request, and when connecting.

pub async fn list( &self, status: Option<CombatStatus>, ) -> Result<Vec<CombatSummary>, ClientError>

The logged-in campaign’s combats, most recently active first, optionally only those in one status (e.g. paused combats waiting to be resumed).

pub async fn create(&self, name: &str) -> Result<CombatSnapshot, ClientError>

Creates a combat in the logged-in campaign.

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

Creates a combat from a planned encounter, with the plan’s monsters in it, called name or after the plan. All or nothing.

pub async fn snapshot(&self, id: Uuid) -> Result<CombatSnapshot, ClientError>

Round, whose turn it is, initiative order and effects in play.

pub async fn log( &self, id: Uuid, after: u64, ) -> Result<Vec<LoggedEvent>, ClientError>

The log after position after (0 for all of it).

pub async fn command( &self, id: Uuid, envelope: &CommandEnvelope, ) -> Result<Vec<LoggedEvent>, ClientError>

Runs a command over plain HTTP and returns the events it produced. Safe to retry: a repeated command_id returns the original events.

pub async fn encounters(&self) -> Result<Vec<Encounter>, ClientError>

The campaign’s planned encounters, by name.

pub async fn encounter(&self, id: Uuid) -> Result<Encounter, ClientError>

One planned encounter.

pub async fn create_encounter( &self, plan: &EncounterPlan, ) -> Result<Encounter, ClientError>

Keeps a new plan.

pub async fn replace_encounter( &self, id: Uuid, plan: &EncounterPlan, ) -> Result<Encounter, ClientError>

Replaces a plan; the last save wins.

pub async fn delete_encounter(&self, id: Uuid) -> Result<(), ClientError>

Deletes a plan.

pub async fn connect(&self, id: Uuid) -> Result<CombatConnection, ClientError>

Opens a live connection. The first message is always a snapshot.

Trait Implementations

impl Clone for CombatClient

fn clone(&self) -> CombatClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CombatClient

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

Formats the value using the given formatter.