cache

Documentation

Index

• Variables
• type Cache
• type Value

Variables

var (
	// ErrElementNotFound is returned when element isn't found in the cache.
	ErrElementNotFound = fmt.Errorf("unable to find element")
)

Types

type Cache

type Cache[K comparable, V Value] interface {
	// Put stores the given (key,value) pair, replacing existing value if
	// key already exists. The return value indicates whether items had to
	// be evicted to make room for the new element.
	Put(key K, value V) (bool, error)

	// Get returns the value for a given key.
	Get(key K) (V, error)

	// Len returns number of elements in the cache.
	Len() int
}

Cache represents a generic cache.

type Value

type Value interface {
	// Size determines how big this entry would be in the cache. For
	// example, for a filter, it could be the size of the filter in bytes.
	Size() (uint64, error)
}

Value represents a value stored in the Cache.