memory

Documentation

Index

• Variables
• func Store[K comparable, V any](_ context.Context, cfg *Config) (cache.Cacher[K, V], error)
• type Config
• type Memory
  • func (m *Memory[K, V]) Delete(_ context.Context, key K) error
  • func (m *Memory[K, V]) Get(_ context.Context, key K) (V, bool, error)
  • func (m *Memory[K, V]) Set(_ context.Context, key K, value V) error

Variables

var (
	DefaultMaxItems         = 1_000
	DefaultTTL              = 10 * time.Minute
	DefaultJanitorInterval  = 1 * time.Minute
	DefaultCompactThreshold = 1_000
)

Functions

func Store

func Store[K comparable, V any](_ context.Context, cfg *Config) (cache.Cacher[K, V], error)

Types

type Config

type Config struct {
	MaxItems int           `cfg:"max_items" json:"max_items"`
	TTL      time.Duration `cfg:"ttl"       json:"ttl"`

	JanitorInterval time.Duration `cfg:"janitor_interval" json:"janitor_interval"`

	// CompactThreshold is the minimum peak item count before map compaction
	// is considered. When the map shrinks to ≤25% of its peak size and the
	// peak exceeded this threshold, the map is rebuilt to release memory.
	// Default is 1000.
	CompactThreshold int `cfg:"compact_threshold" json:"compact_threshold"`
}

type Memory

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

func (*Memory[K, V]) Delete

func (m *Memory[K, V]) Delete(_ context.Context, key K) error

func (*Memory[K, V]) Get

func (m *Memory[K, V]) Get(_ context.Context, key K) (V, bool, error)

func (*Memory[K, V]) Set

func (m *Memory[K, V]) Set(_ context.Context, key K, value V) error