basic

Documentation

Index

• Constants
• type BasicCache
  • func NewCache[T any](options ...Option) (*BasicCache[T], error)
  • func (c *BasicCache[T]) Close()
  • func (c *BasicCache[T]) Delete(key string)
  • func (c *BasicCache[T]) Get(key string) (T, bool)
  • func (c *BasicCache[T]) Set(key string, value T, cost uint64, expiresInSeconds int64) error
  • func (c *BasicCache[T]) SetWithDefaultTTL(key string, value T, cost uint64) error
• type CacheItem
• type Config
• type EvictItemFunc
• type Option
  • func WithCleanupFrequency(cleanupFrequency time.Duration) Option
  • func WithEvictionFunction(f EvictItemFunc) Option
  • func WithMaxCost(maxCost uint64) Option
  • func WithTTL(ttl time.Duration) Option

Constants

const (
	DefaultTTLSeconds = int64(3600)
	DefaultMaxCost    = uint64(1000)
	DefaultFrequency  = time.Hour
)

Types

type BasicCache

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

func NewCache

func NewCache[T any](options ...Option) (*BasicCache[T], error)

func (*BasicCache[T]) Close

func (c *BasicCache[T]) Close()

func (*BasicCache[T]) Delete

func (c *BasicCache[T]) Delete(key string)

func (*BasicCache[T]) Get

func (c *BasicCache[T]) Get(key string) (T, bool)

func (*BasicCache[T]) Set

func (c *BasicCache[T]) Set(key string, value T, cost uint64, expiresInSeconds int64) error

func (*BasicCache[T]) SetWithDefaultTTL

func (c *BasicCache[T]) SetWithDefaultTTL(key string, value T, cost uint64) error

type CacheItem

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

type Config

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

type EvictItemFunc

type EvictItemFunc func(key string, cost uint64, expiryTime int64, now int64) bool

EvictItemFunc can be used to tell the cache not to evict an item based on the provided, key, value or expiryTime.

type Option

type Option func(*Config)

func WithCleanupFrequency

func WithCleanupFrequency(cleanupFrequency time.Duration) Option

func WithEvictionFunction

func WithEvictionFunction(f EvictItemFunc) Option

func WithMaxCost

func WithMaxCost(maxCost uint64) Option

func WithTTL

func WithTTL(ttl time.Duration) Option