Skip to main content

Module dto

Module dto 

Source
Expand description

Data Transfer Object (DTO) definitions used by the services layer.

Structs§

AvailableGameDTO
Games available for the end user to play.
GameIdDTO
Data transfer object for a game identifier, wrapping a ULID for unique, sortable identification.
PeggingDTO
Pegging scores broken down by category.
PeggingSummaryDTO
A summary of pegging points for a particular category.
PlayerStateDTO
Represents the current state of a player for API clients.
PlaysDTO
Represents the current state of plays during a round for API clients.
ScoreDTO
Represents a player’s score for API clients.
UserGameDTO
A Data Transfer Object representing the full state of a game from the perspective of a user.
UserIdDTO
Data transfer object for a user identifier, wrapping a UUID.

Enums§

AvailabilityDTO
Represents the visibility of a game.
AvailableGameEventDTO
Represents a change in the availability of a game.
CardDTO
A DTO representing a Card. The value is the “cid” (Card identifier), e.g. “AS”, “QD”.
DTOError
Errors exposed by the API.
PeggingKindDTO
Enumerates the types of pegging scores in a Cribbage game.
PendingDTO
Represents which player is currently pending an action in the game.
PhaseDTO
Represents the current phase of a game for API clients.
PlayActionDTO
Represents the possible actions a player can take during a turn.
PlayerDTO
Represents a player in the game from the client’s perspective.

Type Aliases§

CardIdDTO
A string identifier for a card.
PeggingBreakdownDTO
Mapping from pegging kinds to the collections of cards that made up were pegged.
PlayDTO
A tuple representing a single play in the game: the player and the card they played.