package lru

Import Path
	github.com/golang/groupcache/lru (on go.dev)

Dependency Relation
	imports one package, and imported by one package

Involved Source Files

	   d➜ lru.go
		Package lru implements an LRU cache.
Package-Level Type Names (total 3, in which 2 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Cache (struct)
		Cache is an LRU cache. It is not safe for concurrent access.

		Fields (total 4, in which 2 are exported)
			MaxEntries int
				MaxEntries is the maximum number of cache entries before
				an item is evicted. Zero means no limit.

			OnEvicted func(key Key, value interface{})
				OnEvicted optionally specifies a callback function to be
				executed when an entry is purged from the cache.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			cache map[interface{}]*list.Element
			ll *list.List
		Methods (total 7, in which 6 are exported)
			(*T) Add(key Key, value interface{})
				Add adds a value to the cache.

			(*T) Clear()
				Clear purges all stored items from the cache.

			(*T) Get(key Key) (value interface{}, ok bool)
				Get looks up a key's value from the cache.

			(*T) Len() int
				Len returns the number of items in the cache.

			(*T) Remove(key Key)
				Remove removes the provided key from the cache.

			(*T) RemoveOldest()
				RemoveOldest removes the oldest item from the cache.

			/* one unexported ... *//* one unexported: */
			(*T) removeElement(e *list.Element)
		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*T : github.com/aws/aws-sdk-go/aws/corehandlers.lener
		As Outputs Of (at least one exported)
			func New(maxEntries int) *Cache

	 type Key (interface)
		A Key may be any value that is comparable. See http://golang.org/ref/spec#Comparison_operators

		As Inputs Of (at least 3, all are exported)
			func (*Cache).Add(key Key, value interface{})
			func (*Cache).Get(key Key) (value interface{}, ok bool)
			func (*Cache).Remove(key Key)

	/* one unexported ... *//* one unexported: */
	 type entry (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			key Key
			value interface{}


Package-Level Functions (only one, which is exported)

	 func New(maxEntries int) *Cache
		New creates a new Cache.
		If maxEntries is zero, the cache has no limit and it's assumed
		that eviction is done by the caller.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin 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 @Go100and1 (reachable from the left QR code) to get the latest news of Golds.