userprefs

package module

Go to main page

Versions in this module

v1

v1.2.1

May 29, 2025

v1.2.0

May 28, 2025

v1.1.0

May 28, 2025

Changes in this version

+ var ErrEncryptionFailed = errors.New("encryption operation failed")

+ var ErrEncryptionRequired = errors.New("encryption manager required for encrypted preferences")

+ type EncryptionAdapter struct

+ func NewEncryptionAdapter() (*EncryptionAdapter, error)

+ func NewEncryptionAdapterWithKey(key []byte) (*EncryptionAdapter, error)

+ func (e *EncryptionAdapter) Decrypt(encrypted string) (string, error)

+ func (e *EncryptionAdapter) Encrypt(plaintext string) (string, error)

+ type EncryptionManager interface

+ Decrypt func(encrypted string) (string, error)

+ Encrypt func(plaintext string) (string, error)

type Option

+ func WithEncryption(em EncryptionManager) Option

type PreferenceDefinition

+ Encrypted bool

v1.0.0

May 19, 2025

Changes in this version

+ const BoolType

+ const FloatType

+ const IntType

+ const JSONType

+ const StringType

+ var ErrAlreadyExists = errors.New("resource already exists")

+ var ErrCacheClosed = errors.New("cache is closed")

+ var ErrInternal = errors.New("internal server error")

+ var ErrSerialization = errors.New("data serialization error")

+ var ErrValidation = errors.New("preference validation failed")

+ type LogLevel int

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelInfo

+ const LogLevelWarn

type Logger

+ func NewDefaultLogger() Logger

+ SetLevel func(level LogLevel)

type Manager

+ func (m *Manager) GetAllDefinitions(_ context.Context) ([]*PreferenceDefinition, error)

+ func (m *Manager) GetDefinition(key string) (PreferenceDefinition, bool)

type PreferenceDefinition

+ ValidateFunc func(value interface{}) error

+ type PreferenceType string

v0

v0.1.0

Nov 27, 2024

Changes in this version

+ var ErrCacheUnavailable = errors.New("cache backend unavailable")

+ var ErrInvalidInput = errors.New("invalid input parameters")

+ var ErrInvalidKey = errors.New("invalid preference key")

+ var ErrInvalidType = errors.New("invalid preference type")

+ var ErrInvalidValue = errors.New("invalid preference value")

+ var ErrNotFound = errors.New("preference not found")

+ var ErrPreferenceNotDefined = errors.New("preference not defined")

+ var ErrStorageUnavailable = errors.New("storage backend unavailable")

+ type Cache interface

+ Close func() error

+ Delete func(ctx context.Context, key string) error

+ Get func(ctx context.Context, key string) (interface{}, error)

+ Set func(ctx context.Context, key string, value interface{}, ttl time.Duration) error

+ type Config struct

+ type Logger interface

+ Debug func(msg string, args ...interface{})

+ Error func(msg string, args ...interface{})

+ Info func(msg string, args ...interface{})

+ Warn func(msg string, args ...interface{})

+ type Manager struct

+ func New(opts ...Option) *Manager

+ func (m *Manager) DefinePreference(def PreferenceDefinition) error

+ func (m *Manager) Delete(ctx context.Context, userID, key string) error

+ func (m *Manager) Get(ctx context.Context, userID, key string) (*Preference, error)

+ func (m *Manager) GetAll(ctx context.Context, userID string) (map[string]*Preference, error)

+ func (m *Manager) GetByCategory(ctx context.Context, userID, category string) (map[string]*Preference, error)

+ func (m *Manager) Set(ctx context.Context, userID, key string, value interface{}) error

+ type Option func(*Config)

+ func WithCache(cache Cache) Option

+ func WithLogger(l Logger) Option

+ func WithStorage(s Storage) Option

+ type Preference struct

+ Category string

+ DefaultValue interface{}

+ Key string

+ Type string

+ UpdatedAt time.Time

+ UserID string

+ Value interface{}

+ type PreferenceDefinition struct

+ AllowedValues []interface{}

+ Category string

+ DefaultValue interface{}

+ Key string

+ Type string

+ type Storage interface

+ Close func() error

+ Delete func(ctx context.Context, userID, key string) error

+ Get func(ctx context.Context, userID, key string) (*Preference, error)

+ GetAll func(ctx context.Context, userID string) (map[string]*Preference, error)

+ GetByCategory func(ctx context.Context, userID, category string) (map[string]*Preference, error)

+ Set func(ctx context.Context, pref *Preference) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL