xcfg

Documentation

Index

• type Buffer
• type JsonConfig
  • func NewJsonConfig(filepath string, defaults map[string]any) *JsonConfig
  • func (cfg JsonConfig) EnableBackup(bakpath string)
  • func (cfg JsonConfig) GetSecure(key string, defval any) (any, error)
  • func (cfg JsonConfig) InitAES128(secret string) error
  • func (cfg JsonConfig) InitAES256(secret string) error
  • func (cfg JsonConfig) IsBackupExist() bool
  • func (cfg JsonConfig) IsExist() bool
  • func (cfg JsonConfig) Load() error
  • func (cfg JsonConfig) Purge() error
  • func (cfg JsonConfig) Reset()
  • func (cfg JsonConfig) Save() error
  • func (cfg JsonConfig) SetSecure(key string, val any) error

Types

type Buffer

type Buffer = types.NDict

type JsonConfig

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

json file config

func NewJsonConfig

func NewJsonConfig(filepath string, defaults map[string]any) *JsonConfig

create new json config file handler

func (JsonConfig) EnableBackup

func (cfg JsonConfig) EnableBackup(bakpath string)

enable config file backup support

func (JsonConfig) GetSecure

func (cfg JsonConfig) GetSecure(key string, defval any) (any, error)

get secure value from config by key

func (JsonConfig) InitAES128

func (cfg JsonConfig) InitAES128(secret string) error

func (JsonConfig) InitAES256

func (cfg JsonConfig) InitAES256(secret string) error

func (JsonConfig) IsBackupExist

func (cfg JsonConfig) IsBackupExist() bool

check backup config file exist on disk, if backup support enabled.

func (JsonConfig) IsExist

func (cfg JsonConfig) IsExist() bool

check config file exist on disk

func (JsonConfig) Load

func (cfg JsonConfig) Load() error

read raw bytes content of config file, if error: then check and read the backup file if backup support enabled.

func (JsonConfig) Purge

func (cfg JsonConfig) Purge() error

delete config and backup files from disk and reset local buffer

func (JsonConfig) Reset

func (cfg JsonConfig) Reset()

reset local buffer

func (JsonConfig) Save

func (cfg JsonConfig) Save() error

write raw bytes content to config file, if not error: then check and write backup config if backup support enabled.

func (JsonConfig) SetSecure

func (cfg JsonConfig) SetSecure(key string, val any) error

set secure value in config by key, creates key if not exist