bigcache

Documentation

Index

• func ConfigAdd(path string)
• func NewCache(ctx context.Context) (*bigcache.BigCache, error)
• func NewCacheWithConfigPath(ctx context.Context, path string) (*bigcache.BigCache, error)
• func NewCacheWithOptions(ctx context.Context, opt *Options) (cache *bigcache.BigCache, err error)
• type Options
  • func NewOptions() (*Options, error)
  • func NewOptionsWithPath(path string) (opts *Options, err error)

Functions

func ConfigAdd

func ConfigAdd(path string)

func NewCache

func NewCache(ctx context.Context) (*bigcache.BigCache, error)

NewCache returns a cache.

func NewCacheWithConfigPath

func NewCacheWithConfigPath(ctx context.Context, path string) (*bigcache.BigCache, error)

NewCacheWithConfig returns a cache with options from config path .

func NewCacheWithOptions

func NewCacheWithOptions(ctx context.Context, opt *Options) (cache *bigcache.BigCache, err error)

NewCacheWithOptions returns a cache with options.

Types

type Options

type Options struct {
	Shards             int
	LifeWindow         time.Duration
	CleanWindow        time.Duration
	MaxEntriesInWindow int
	MaxEntrySize       int
	Verbose            bool
	HardMaxCacheSize   int
	StatsEnabled       bool
}

func NewOptions

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals a given key path into options and returns it.