cache

Documentation

Index

• type Cache
• type Provider
  • func (p *Provider) Wrap(storageProvider StorageProvider, opts ...WrapOption) storage.Provider
• type StorageProvider
• type Store
• type WrapOption
  • func WithCacheTTL(ttl time.Duration) WrapOption

Types

type Cache

type Cache interface {
	Get(key interface{}) (interface{}, bool)
	SetWithTTL(key, value interface{}, cost int64, ttl time.Duration) bool
	Del(key interface{})
	Clear()
}

Cache represents caching functionality. Concrete implementation is expected to be thread-safe.

type Provider

type Provider struct {
	Cache Cache
}

Provider provides the underlying StorageProvider with caching support.

func (*Provider) Wrap

func (p *Provider) Wrap(storageProvider StorageProvider, opts ...WrapOption) storage.Provider

Wrap adds caching support to the underlying StorageProvider.

type StorageProvider

type StorageProvider = storage.Provider

StorageProvider is an alias for storage.Provider.

type Store

type Store = storage.Store

Store is an alias for storage.Store.

type WrapOption

type WrapOption func(p *wrapOptions)

WrapOption configures wrapped provider.

func WithCacheTTL

func WithCacheTTL(ttl time.Duration) WrapOption

WithCacheTTL sets the TTL (time to live) for cache items.