cache

Documentation

Index

• Variables
• type Bucket
• type BucketOptions
• type CacheOptions
• type TCache
  • func New() TCache
  • func NewWithOpts(opts CacheOptions) TCache

Variables

var (
	ErrNotFound = errors.New("key not found")
	ErrMaxItems = errors.New("max items reached")
)

Types

type Bucket

type Bucket interface {
	Get(string) (any, bool)
	Set(string, any)
	Len() int
	SetWithTTL(string, any, time.Duration)
	Delete(string) bool
}

type BucketOptions

type BucketOptions struct {
	// TTL is the time after which the key will be deleted from the cache.
	DefaultTTL time.Duration
	// MaxItems is the maximum number of items that can be stored in the cache.
	// If set to 0, there is no limit.
	MaxItems int
}

type CacheOptions

type CacheOptions struct {
	CheckInterval time.Duration
	Logger        *zap.Logger
}

type TCache

type TCache interface {
	Bucket(string) Bucket
	BucketWithOpts(string, BucketOptions) Bucket
	Clear()
}

func New

func New() TCache

func NewWithOpts

func NewWithOpts(opts CacheOptions) TCache