lrucache

package

v1.101.0 Latest Latest Go to latest Published: Apr 25, 2024 License: Apache-2.0 Imports: 9 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

Cache caches Entry entries.

Call NewCache() for creating new Cache.

func NewCache(getMaxSizeBytes func() int) *Cache

NewCache creates new cache.

Cache size in bytes is limited by the value returned by getMaxSizeBytes() callback. Call MustStop() in order to free up resources occupied by Cache.

func (c *Cache) GetEntry(k string) Entry

GetEntry returns an Entry for the given key k from c.

func (c *Cache) Len() int

Len returns the number of blocks in the cache c.

func (c *Cache) Misses() uint64

Misses returns the number of cache misses for c.

func (c *Cache) MustStop()

MustStop frees up resources occupied by c.

func (c *Cache) PutEntry(k string, e Entry)

PutEntry puts the given Entry e under the given key k into c.

func (c *Cache) Requests() uint64

Requests returns the number of requests served by c.

func (c *Cache) SizeBytes() int

SizeBytes returns an approximate size in bytes of all the blocks stored in the cache c.

func (c *Cache) SizeMaxBytes() int

SizeMaxBytes returns the max allowed size in bytes for c.

type Entry interface {
	// SizeBytes must return the approximate size of the given entry in bytes
	SizeBytes() int
}

Entry is an item, which may be cached in the Cache.