factions

Documentation

Index

• type CreationInput
• type Faction
• type FindManyQuery
• type FindOneQuery
• type Reader
• type Repository
• type Writer

Types

type CreationInput

type CreationInput struct {
	WikiID  int    `validate:"required"`
	URL     string `validate:"required,url"`
	Name    string `validate:"required"`
	Summary string
}

CreationInput is a struct that contains all of the data required to create a faction. This includes annotations required by validations

type Faction

type Faction struct {
	ID      uuid.UUID `json:"id"`
	WikiID  int       `json:"wikiID"`
	URL     string    `json:"url"`
	Name    string    `json:"name"`
	Summary string    `json:"summary"`
}

Faction is an organization to which the commanders and other units involved in a battle belong. These may be countries, kingdoms, empires, or other similar entities depending on the historical context of the period of time

type FindManyQuery

type FindManyQuery struct {
	CommanderID uuid.UUID
	Name        string
	Summary     string
}

FindManyQuery is used to refine the filters when finding many factions

type FindOneQuery

type FindOneQuery struct {
	ID   uuid.UUID
	Name string
	URL  string
}

FindOneQuery is used to refine the filters when finding one faction

type Reader

type Reader interface {
	FindOne(query FindOneQuery) (Faction, error)
	FindMany(query FindManyQuery, page int) ([]Faction, int, error)
}

Reader is the interface through which factions may be read

type Repository

type Repository interface {
	Reader
	Writer
}

Repository is the interface through which factions may be read and written

type Writer

type Writer interface {
	CreateOne(data CreationInput) (uuid.UUID, error)
}

Writer is the interface through which factions may be written