Struct Game 

pub struct Game { /* private fields */ }

Represents a game with a host, optional guest (i.e. no one has joined and game is deemed to be in the lobby), name, and current state.

Implementations

impl Game

pub fn new( id: GameId, host: UserId, guest: Option<UserId>, name: &str, state: Phase, ) -> Self

Creates a new Game with the specified ID, host, optional guest, name, and state.

pub fn id(&self) -> GameId

Returns the unique identifier of the game.

pub fn host(&self) -> UserId

Returns the user ID of the host.

pub fn guest(&self) -> Option<UserId>

Returns the user ID of the guest, if any.

pub fn name(&self) -> &str

Returns the name of the game.

pub fn phase(&self) -> &Phase

Returns the current phase of the game.

pub fn validate_user(&self, user_id: UserId) -> Option<Player>

Returns the player corresponding to the given user ID, if they are part of this game.

Trait Implementations

impl Aggregate for Game

const TYPE: &'static str = "Game"

The aggregate type is used as the unique identifier for this aggregate and its events. This is used for persisting the events and snapshots to a database.

type Command = GameCommand

Specifies the inbound command used to make changes in the state of the Aggregate.

type Event = GameEvent

Specifies the published events representing some change in state of the Aggregate.

type Error = DomainError

The error returned when a command fails due to business logic. This is used to provide feedback to the user as to the nature of why the command was refused.

type Services = GameServices

The external services required for the logic within the Aggregate

async fn handle( &mut self, command: Self::Command, _services: &Self::Services, sink: &EventSink<Self>, ) -> Result<(), Self::Error>

This method consumes and processes commands. The result should be either a vector of events if the command is successful, or an error if the command is rejected.

fn apply(&mut self, event: Self::Event)

This is used to update the aggregate’s state once an event has been committed. Any events returned from the handle method will be applied using this method in order to populate the state of the aggregate instance.

impl Clone for Game

fn clone(&self) -> Game

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Game

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

Formats the value using the given formatter.

impl Default for Game

fn default() -> Game

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Game

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Game

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

Formats the value using the given formatter.

impl PartialEq for Game

fn eq(&self, other: &Game) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Game

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Game

impl StructuralPartialEq for Game