database

type Database[M any] struct {
	// contains filtered or unexported fields
}

type ModelCollectionOptions[K comparable, V any, DB any] struct {
	// IdentifyOwner is function that returns the owner key for grouping models
	IdentifyOwner func(V) K
	// IdentifyModel is function that returns unique identifier for each model
	IdentifyModel func(V) K
	// IdentifyDBModel is same function as above, but for DB models
	IdentifyDBModel func(DB) K
	// ModifyQuery is function that must return arguments (query) to modify
	// model in the database
	ModifyQuery func(DB) (string, []any)
	// CreateDBModel is function that creates database models from entries
	CreateDBModel func(K, V) DB
	// CreateModel should create default model from DB model
	CreateModel func(DB) V
	// CompareModels is function to compare two DB models
	CompareModels func(DB, DB) bool
	// AlwaysUpdate marks if we should always update all models
	AlwaysUpdate bool
	// NeverUpdate marks if provider should never update the database models
	NeverUpdate bool
	// OnLoad is function that is called right before model is going to be
	// added. It can cancel adding model by returning false in this function.
	OnLoad func(ownerKey K, model *V, dbModel DB) bool
}

type ModelOptions[K comparable, V any, DB any] struct {
	// Identify is function that allows user by itself get identifier of this
	// model. Without it, models can't be stored by 'map[key]model'.
	IdentifyModel func(V) K
	// IdentifyDBModel is same function as above, but for DB models.
	IdentifyDBModel func(DB) K
	// ModifyQuery is function, that must return arguments (query) to modify
	// model in the database.
	// Example:
	//
	// func (m myModel) modifyQuery() (string, []any) {
	//    return "uuid = ?", []any{m.MyUUID}
	// }
	ModifyQuery func(DB) (string, []any)
	// CreateDBModel is function that is required to create database models
	// from entries (convert models from Provider memory to database models and
	// save them)
	CreateDBModel func(K, V) DB
	// CreateModel should create default model from DB model.
	CreateModel func(DB) V
	// CompareModels is function to compare two DB models. It is required to
	// check, if we need to update model in the database.
	CompareModels func(DB, DB) bool
	// AlwaysUpdate is boolean that marks, if we should always update all
	// models in the database (without comparing). If it is true, CompareModels
	// can be nil.
	AlwaysUpdate bool
	// NeverUpdate is boolean, that marks if provider should never update the
	// database models. Example: database of archived punishments, we're just
	// adding models without modifying them.
	NeverUpdate bool
	// OnLoad is function that is called right before model is going to be
	// added. It can cancel adding model by returning false in this function.
	OnLoad func(K, *V, DB) bool
}

type Provider[K comparable, V, DB any] interface {
	// Closer only has "Close() error" method.
	// Close method should save modified models to database and close the
	// parent database.
	io.Closer
	// PutEntry tries to put entry to the provider memory.
	// It returns false, if there's already an entry by this key.
	PutEntry(K, V) bool
	PutEntryUnsafe(K, V) bool
	// SetEntry updates the entry by key (stores to provider memory).
	// It'll override, if there is an entry by this key
	SetEntry(K, V)
	SetEntryUnsafe(K, V)
	// DeleteEntry deletes entry from the provider by its key.
	DeleteEntry(K)
	DeleteEntryUnsafe(K)
	// LoadEntry tries to load the entry from provider.
	LoadEntry(K) (V, bool)
	LoadEntryUnsafe(K) (V, bool)
	// LoadEntryFunc tries to load the entry from provider by iterating across
	// all entries.
	LoadEntryFunc(yield func(K, V) bool) (V, bool)
	LoadEntryFuncUnsafe(yield func(K, V) bool) (V, bool)
	// Entries returns iterator of all provider entries.
	Entries() iter.Seq[V]
	EntriesUnsafe() iter.Seq[V]
	// MapEntries returns key-value iterator of all provider entries.
	MapEntries() iter.Seq2[K, V]
	MapEntriesUnsafe() iter.Seq2[K, V]
	// Load initializes the provider. It loads all models from the database.
	// It can be only called once.
	Load()
	// Database returns database instance of this provider.
	Database() *Database[DB]
	// L returns entries mutex (locker) for this provider.
	L() *sync.RWMutex
}

type ProviderCollection[K comparable, V, DB any] interface {
	io.Closer
	// PutEntry adds an entry to the collection
	// Returns false if an entry with the same model key already exists
	PutEntry(K, V) bool
	PutEntryUnsafe(K, V) bool
	// SetEntry adds or replaces an entry in the collection
	SetEntry(K, V)
	SetEntryUnsafe(K, V)
	// RemoveEntry removes a specific entry from the collection
	RemoveEntry(V)
	RemoveEntryUnsafe(V)
	// RemoveEntryByID removes a specific entry from the collection by
	// its identification.
	RemoveEntryByID(ownerKey, modelKey K)
	RemoveEntryByIDUnsafe(ownerKey, modelKey K)
	// RemoveEntries removes all entries for a specific owner key
	RemoveEntries(K)
	RemoveEntriesUnsafe(K)
	// LoadEntries returns all entries for a specific owner key
	LoadEntries(key K, clone bool) ([]V, bool)
	LoadEntriesUnsafe(key K, clone bool) ([]V, bool)
	// Entries returns iterator of all entries in the collection
	Entries() iter.Seq[V]
	EntriesUnsafe() iter.Seq[V]
	// MapEntries returns key-collection iterator of all provider entries
	MapEntries() iter.Seq2[K, []V]
	MapEntriesUnsafe() iter.Seq2[K, []V]
	// Load initializes the provider collection
	Load()
	// Database returns database instance of this provider.
	Database() *Database[DB]
	// L returns entries mutex (locker) for this provider.
	L() *sync.RWMutex
}

type ProviderCollectionImpl[K comparable, V any, DB any] struct {
	// contains filtered or unexported fields
}

type ProviderImpl[K comparable, V any, DB any] struct {
	// contains filtered or unexported fields
}