cache

Documentation

Index

• Constants
• Variables
• func DefaultMarshalFunc(value any) ([]byte, error)
• func DefaultUnmarshalFunc(b []byte, value any) error
• func Del(ctx context.Context, key string) error
• func Get(ctx context.Context, key string, v any, opts ...Option) error
• func Has(ctx context.Context, key string) bool
• func IsNotFound(err error) bool
• func RegisterCache(name string, cache Cache) error
• func Set(ctx context.Context, key string, v any, opts ...Option) error
• func SetDefault(driver string) error
• func UnRegisterCache(name string)
• type Cache
  • func GetCache(driver string) (Cache, error)
• type MarshalFunc
• type Option
  • func WithGetter(getter func(ctx context.Context, key string) (any, error)) Option
  • func WithGroup() Option
  • func WithRaw() Option
  • func WithSetNX() Option
  • func WithSetXX() Option
  • func WithSkip(skip SkipMode) Option
  • func WithTTL(ttl time.Duration) Option
• type Options
  • func ApplyOptions(opts ...Option) *Options
  • func (o *Options) Expiration() time.Duration
• type SkipMode
  • func (f SkipMode) Any() bool
  • func (f SkipMode) Is(mode SkipMode) bool
• type Stats
  • func (s *Stats) AddHit()
  • func (s *Stats) AddMiss()
• type UnmarshalFunc

Constants

const (
	CacheKindRedis = "redis"
)

Variables

var (
	ErrDriverNameMiss = errors.New("cache: driverName is empty")
	ErrCacheMiss      = errors.New("cache: key is missing")
)

Functions

func DefaultMarshalFunc

func DefaultMarshalFunc(value any) ([]byte, error)

func DefaultUnmarshalFunc

func DefaultUnmarshalFunc(b []byte, value any) error

func Del

func Del(ctx context.Context, key string) error

func Get

func Get(ctx context.Context, key string, v any, opts ...Option) error

func Has

func Has(ctx context.Context, key string) bool

func IsNotFound

func IsNotFound(err error) bool

func RegisterCache

func RegisterCache(name string, cache Cache) error

RegisterCache registers a cache driver. It is not safe for concurrent use.

func Set

func Set(ctx context.Context, key string, v any, opts ...Option) error

func SetDefault

func SetDefault(driver string) error

SetDefault sets the default driver to use the static functions.

func UnRegisterCache

func UnRegisterCache(name string)

UnRegisterCache unregisters a cache driver. It is not safe for concurrent use.

Types

type Cache

type Cache interface {
	// Get gets the value from cache and unmarshal it to v. Make sure the value is a pointer and zero.
	Get(ctx context.Context, key string, value any, opts ...Option) error
	// Set sets the value to cache.
	Set(ctx context.Context, key string, value any, opts ...Option) error
	// Has reports whether the value for the given key exists.
	Has(ctx context.Context, key string) bool
	// Del deletes the value for the given key.
	Del(ctx context.Context, key string) error
	// IsNotFound detect the error weather not found from cache
	IsNotFound(err error) bool
}

Cache is the interface for cache.

func GetCache

func GetCache(driver string) (Cache, error)

GetCache return a registered Cache driver.

type MarshalFunc

type MarshalFunc func(any) ([]byte, error)

type Option

type Option func(*Options)

func WithGetter

func WithGetter(getter func(ctx context.Context, key string) (any, error)) Option

WithGetter sets the cache getter.

func WithGroup

func WithGroup() Option

WithGroup sets the cache Group.

func WithRaw

func WithRaw() Option

WithRaw sets the cache Raw.

func WithSetNX

func WithSetNX() Option

WithSetNX sets the cache SetNX.

func WithSetXX

func WithSetXX() Option

WithSetXX sets the cache SetXX.

func WithSkip

func WithSkip(skip SkipMode) Option

WithSkip sets the cache Skip.

func WithTTL

func WithTTL(ttl time.Duration) Option

WithTTL sets the cache expiration time.

type Options

type Options struct {
	// TTL is the cache expiration time.
	TTL time.Duration
	// Getter returns value to be cached.call getter to get a value(such as query database) and set cache using c.expiry
	Getter func(ctx context.Context, key string) (any, error)
	// SetXX only sets the key if it already exists.
	SetXX bool
	// SetNX only sets the key if it does not already exist.
	SetNX bool
	// SkipFlags indicator skip level.
	Skip SkipMode
	// Raw indicates whether to skip serialization. default is false to keep coroutine safe.
	// Caches accessed across processes are serialized, that flag Generally used for memory cache.
	//
	// false that means serialize value to Item.V. if true, Item.V is raw value but support by implemented Cache.
	// has implemented Cache: lfu cache
	Raw bool
	// Group indicates whether to singleflight.
	Group bool
}

func ApplyOptions

func ApplyOptions(opts ...Option) *Options

func (*Options) Expiration

func (o *Options) Expiration() time.Duration

type SkipMode

type SkipMode int

SkipMode controls the cache load which level from a combined cache .

const (
	SkipLocal SkipMode = 1 << iota
	SkipRemote
	// SkipCache skip cache load,means load from source
	SkipCache = SkipLocal | SkipRemote
)

func (SkipMode) Any

func (f SkipMode) Any() bool

Any returns true if the skip annotation was set.

func (SkipMode) Is

func (f SkipMode) Is(mode SkipMode) bool

Is checks if the skip annotation has a specific flag.

type Stats

type Stats struct {
	Hits   uint64
	Misses uint64
}

Stats is the redis cache analyzer.

func (*Stats) AddHit

func (s *Stats) AddHit()

func (*Stats) AddMiss

func (s *Stats) AddMiss()

type UnmarshalFunc

type UnmarshalFunc func([]byte, any) error