bigcache

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

type Config struct {
	// Number of cache shards, value must be a power of two
	Shards int
	// Time after which entry can be evicted
	LifeWindow time.Duration
	// Interval between removing expired entries (clean up).
	// If set to <= 0 then no action is performed. Setting to < 1 second is counterproductive — bigcache has a one second resolution.
	CleanWindow time.Duration
	// Max number of entries in life window. Used only to calculate initial size for cache shards.
	// When proper value is set then additional memory allocation does not occur.
	MaxEntriesInWindow int
	// Max size of entry in bytes. Used only to calculate initial size for cache shards.
	MaxEntrySize int
	// Verbose mode prints information about new memory allocation
	Verbose bool
	// Hasher used to map between string keys and unsigned 64bit integers, by default fnv64 hashing is used.
	Hasher Hasher
	// HardMaxCacheSize is a limit for cache size in MB. Cache will not allocate more memory than this limit.
	// It can protect application from consuming all available memory on machine, therefore from running OOM Killer.
	// Default value is 0 which means unlimited size. When the limit is higher than 0 and reached then
	// the oldest entries are overridden for the new ones.
	HardMaxCacheSize int
	// OnRemove is a callback fired when the oldest entry is removed because of its expiration time or no space left
	// for the new entry. Default value is nil which means no callback and it prevents from unwrapping the oldest entry.
	OnRemove func(key string, entry []byte)

	// Logger is a logging interface and used in combination with `Verbose`
	// Defaults to `DefaultLogger()`
	Logger Logger
}

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

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

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

type Hasher interface {
	Sum64(string) uint64
}

type Logger interface {
	Printf(format string, v ...interface{})
}

type Stats struct {
	// Hits is a number of successfully found keys
	Hits int64
	// Misses is a number of not found keys
	Misses int64
	// DelHits is a number of successfully deleted keys
	DelHits int64
	// DelMisses is a number of not deleted keys
	DelMisses int64
	// Collisions is a number of happened key-collisions
	Collisions int64

	EvictCount int64
}