settings

type Object ¶

type Object[T any] struct {
	// contains filtered or unexported fields
}

Object 设置对象的操作接口

T 为实际的设置对象，必须得是一个结构体类型。 如果 T 的指针还实现了 Sanitizer 接口，那么在加载或是写入数据源成功之后会调用该接口对数据进行修正。 用户对 T 的修改应该及时采用 [Object.Put] 写入数据源，否则在重启后这些修改不会生效。

其每一个公开字段在数据库中表示为一条记录。如果要改变在数据库对应的字段名， 可以为每一个字段添加 setting 标签，比如：

struct X {
    Field string `setting:"field"`
}

默认为字段名，如果不需要该字段，可以采用小写或是 setting:"-" 对其忽略。 如果字段是非内置的类型，可以实现 json 的相关接口实现自定义的存储和读取功能。

func LoadObject[T any](s *Settings, id string, ttl time.Duration) (*Object[T], error)

func (obj *Object[T]) Get(uid int64) (*T, error)

func (obj *Object[T]) HandleGet(ctx *web.Context, uid int64) web.Responser

func (obj *Object[T]) HandlePut(ctx *web.Context, uid int64) web.Responser

func (obj *Object[T]) Set(uid int64, o *T) error

type Sanitizer ¶

type Sanitizer interface {
	SanitizeSettings() error
}

type Settings ¶

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

func Install(mod *cmfx.Module, tableName string) *Settings

func New(mod *cmfx.Module, tableName string) *Settings