cachecontracts

Documentation

Index

• func Cache[ENT any, ID comparable](repository cachepkg.Repository[ENT, ID], opts ...Option[ENT, ID]) contract.Contract
• func EntityRepository[ENT any, ID comparable](subject cachepkg.EntityRepository[ENT, ID], ...) contract.Contract
• func HitRepository[EntID any](subject cachepkg.HitRepository[EntID], ...) contract.Contract
• func Repository[Entity any, ID comparable](subject cachepkg.Repository[Entity, ID], opts ...Option[Entity, ID]) contract.Contract
• type CacheSubject
• type Config
  • func (c Config[E, ID]) Configure(t *Config[E, ID])
  • func (c *Config[E, ID]) Init()
• type Option
  • func CRUDOption[E any, ID comparable](opts ...crudcontracts.Option[E, ID]) Option[E, ID]

Functions

func Cache

func Cache[ENT any, ID comparable](repository cachepkg.Repository[ENT, ID], opts ...Option[ENT, ID]) contract.Contract

func EntityRepository

func EntityRepository[ENT any, ID comparable](subject cachepkg.EntityRepository[ENT, ID], commitManager comproto.OnePhaseCommitProtocol, opts ...Option[ENT, ID]) contract.Contract

func HitRepository

func HitRepository[EntID any](subject cachepkg.HitRepository[EntID], commitManager comproto.OnePhaseCommitProtocol, opts ...crudcontracts.Option[cachepkg.Hit[EntID], cachepkg.HitID]) contract.Contract

func Repository

func Repository[Entity any, ID comparable](subject cachepkg.Repository[Entity, ID], opts ...Option[Entity, ID]) contract.Contract

Types

type CacheSubject

type CacheSubject[ENT, ID any] interface {
	cachepkg.Interface[ENT, ID]
	crud.Creator[ENT]
	crud.Saver[ENT]
	crud.ByIDFinder[ENT, ID]
	crud.AllFinder[ENT]
	crud.Updater[ENT]
	crud.ByIDDeleter[ID]
	crud.AllDeleter
}

type Config

type Config[ENT any, ID comparable] struct {
	// MakeID will help  create a valid ENT.ID.
	// In the cache, we work with entities which suppose to be already stored somewhere else
	// so the default use-case for testing the cache.EntityRepository is that entities already have a populated ID.
	// If a randomly generated value not good, you can overwrite this function.
	MakeID func(tb testing.TB) ID
	// CRUD [optional] contracts related configuration.
	CRUD crudcontracts.Config[ENT, ID]
}

func (Config[E, ID]) Configure

func (c Config[E, ID]) Configure(t *Config[E, ID])

func (*Config[E, ID]) Init

func (c *Config[E, ID]) Init()

type Option

type Option[ENT any, ID comparable] interface {
	option.Option[Config[ENT, ID]]
}

func CRUDOption

func CRUDOption[E any, ID comparable](opts ...crudcontracts.Option[E, ID]) Option[E, ID]