package simplelru

Import Path
	github.com/hashicorp/golang-lru/v2/simplelru (on go.dev)

Dependency Relation
	imports 2 packages, and imported by one package

Involved Source Files

	    lru.go
	  d lru_interface.go
		Package simplelru provides simple LRU implementation based on build-in container/list.
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type EvictCallback[K, V] (func)

		Type Parameters:
			K: comparable
			V: any

		EvictCallback is used to get a callback when a cache entry is evicted

		As Inputs Of (at least one exported)
			func NewLRU[K, V](size int, onEvict EvictCallback[K, V]) (*LRU[K, V], error)

	 type LRU[K, V] (struct)

		Type Parameters:
			K: comparable
			V: any

		LRU implements a non-thread safe fixed size LRU cache

		Methods (total 12)
			(*LRU[K, V]) Add(key K, value V) (evicted bool)
				Add adds a value to the cache.  Returns true if an eviction occurred.

			(*LRU[K, V]) Contains(key K) (ok bool)
				Contains checks if a key is in the cache, without updating the recent-ness
				or deleting it for being stale.

			(*LRU[K, V]) Get(key K) (value V, ok bool)
				Get looks up a key's value from the cache.

			(*LRU[K, V]) GetOldest() (key K, value V, ok bool)
				GetOldest returns the oldest entry

			(*LRU[K, V]) Keys() []K
				Keys returns a slice of the keys in the cache, from oldest to newest.

			(*LRU[K, V]) Len() int
				Len returns the number of items in the cache.

			(*LRU[K, V]) Peek(key K) (value V, ok bool)
				Peek returns the key value (or undefined if not found) without updating
				the "recently used"-ness of the key.

			(*LRU[K, V]) Purge()
				Purge is used to completely clear the cache.

			(*LRU[K, V]) Remove(key K) (present bool)
				Remove removes the provided key from the cache, returning if the
				key was contained.

			(*LRU[K, V]) RemoveOldest() (key K, value V, ok bool)
				RemoveOldest removes the oldest item from the cache.

			(*LRU[K, V]) Resize(size int) (evicted int)
				Resize changes the cache size.

			(*LRU[K, V]) Values() []V
				Values returns a slice of the values in the cache, from oldest to newest.

		As Outputs Of (at least one exported)
			func NewLRU[K, V](size int, onEvict EvictCallback[K, V]) (*LRU[K, V], error)

	 type LRUCache[K, V] (interface)

		Type Parameters:
			K: comparable
			V: any

		LRUCache is the interface for simple LRU cache.

		Methods (total 12)
			( LRUCache[K, V]) Add(key K, value V) bool
				Adds a value to the cache, returns true if an eviction occurred and
				updates the "recently used"-ness of the key.

			( LRUCache[K, V]) Contains(key K) (ok bool)
				Checks if a key exists in cache without updating the recent-ness.

			( LRUCache[K, V]) Get(key K) (value V, ok bool)
				Returns key's value from the cache and
				updates the "recently used"-ness of the key. #value, isFound

			( LRUCache[K, V]) GetOldest() (K, V, bool)
				Returns the oldest entry from the cache. #key, value, isFound

			( LRUCache[K, V]) Keys() []K
				Returns a slice of the keys in the cache, from oldest to newest.

			( LRUCache[K, V]) Len() int
				Returns the number of items in the cache.

			( LRUCache[K, V]) Peek(key K) (value V, ok bool)
				Returns key's value without updating the "recently used"-ness of the key.

			( LRUCache[K, V]) Purge()
				Clears all cache entries.

			( LRUCache[K, V]) Remove(key K) bool
				Removes a key from the cache.

			( LRUCache[K, V]) RemoveOldest() (K, V, bool)
				Removes the oldest entry from cache.

			( LRUCache[K, V]) Resize(int) int
				Resizes cache, returning number evicted

			( LRUCache[K, V]) Values() []V
				Values returns a slice of the values in the cache, from oldest to newest.



Package-Level Functions (only one)

	 func NewLRU[K, V](size int, onEvict EvictCallback[K, V]) (*LRU[K, V], error)

		Type Parameters:
			K: comparable
			V: any

		NewLRU constructs an LRU of the given size

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.