models

Documentation

Index

• Constants
• Variables
• type Model
  • func ExtractModel(def any) (*Model, error)
  • func (m *Model) Define(def attrs.Definer, f ...attrs.Field) *attrs.ObjectDefinitions
  • func (m *Model) ModelDataStore() queries.ModelDataStore
  • func (m *Model) ModelMeta() attrs.ModelMeta
  • func (m *Model) RelatedField(name string) (attrs.Field, bool)
  • func (m *Model) SaveFields() error
• type ModelSignal
• type ModelSignalFlag
• type ModelSignalInfo

Constants

const (
	ErrObjectPtr       errs.Error = "object must be a pointer to a struct"
	ErrObjectInvalid   errs.Error = "object is invalid or nil, the object must be a valid pointer to a struct"
	ErrModelEmbedded   errs.Error = "object does not have an embedded Model field, the object must embed the Model struct"
	ErrModelAdressable errs.Error = "the Model is not addressable, the object must embed the Model struct"
	ErrModelType       errs.Error = "object has a non- Model type embedded as the Model field, the object must embed the models.Model struct"
)

Variables

var (
	SIGNAL_MODEL_SETUP = model_signal_pool.Get("models.Model.setup")
)

Types

type Model

type Model struct {
	// contains filtered or unexported fields
}

func ExtractModel

func ExtractModel(def any) (*Model, error)

func (*Model) Define

func (m *Model) Define(def attrs.Definer, f ...attrs.Field) *attrs.ObjectDefinitions

func (*Model) ModelDataStore

func (m *Model) ModelDataStore() queries.ModelDataStore

func (*Model) ModelMeta

func (m *Model) ModelMeta() attrs.ModelMeta

func (*Model) RelatedField

func (m *Model) RelatedField(name string) (attrs.Field, bool)

func (*Model) SaveFields

func (m *Model) SaveFields() error

type ModelSignal

type ModelSignal struct {
	SignalInfo ModelSignalInfo
	Model      *Model
	Object     attrs.Definer
}

type ModelSignalFlag

type ModelSignalFlag uint

const (
	ModelSignalFlagNone ModelSignalFlag = 0
	FlagModelReset      ModelSignalFlag = iota
)

type ModelSignalInfo

type ModelSignalInfo struct {
	Flags ModelSignalFlag
	Data  map[string]any
}