package internal

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

Dependency Relation
	imports one package, and imported by one package

Involved Source Files

	    list.go
Package-Level Type Names (total 2)

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

		Type Parameters:
			K: comparable
			V: any

		Entry is an LRU Entry

		Fields (total 4)
			ExpireBucket uint8
				The expiry bucket item was put in, optional

			ExpiresAt time.Time
				The time this element would be cleaned up, optional

			Key K
				The LRU Key of this element.

			Value V
				The Value stored with this element.

		Methods (only one)
			(*Entry[K, V]) PrevEntry() *Entry[K, V]
				PrevEntry returns the previous list element or nil.

		As Outputs Of (at least 4)
			func (*Entry)[K, V].PrevEntry() *Entry[K, V]
			func (*LruList)[K, V].Back() *Entry[K, V]
			func (*LruList)[K, V].PushFront(k K, v V) *Entry[K, V]
			func (*LruList)[K, V].PushFrontExpirable(k K, v V, expiresAt time.Time) *Entry[K, V]
		As Inputs Of (at least 2)
			func (*LruList)[K, V].MoveToFront(e *Entry[K, V])
			func (*LruList)[K, V].Remove(e *Entry[K, V]) V

	 type LruList[K, V] (struct)

		Type Parameters:
			K: comparable
			V: any

		LruList represents a doubly linked list.
		The zero Value for LruList is an empty list ready to use.

		Methods (total 7)
			(*LruList[K, V]) Back() *Entry[K, V]
				Back returns the last element of list l or nil if the list is empty.

			(*LruList[K, V]) Init() *LruList[K, V]
				Init initializes or clears list l.

			(*LruList[K, V]) Length() int
				Length returns the number of elements of list l.
				The complexity is O(1).

			(*LruList[K, V]) MoveToFront(e *Entry[K, V])
				MoveToFront moves element e to the front of list l.
				If e is not an element of l, the list is not modified.
				The element must not be nil.

			(*LruList[K, V]) PushFront(k K, v V) *Entry[K, V]
				PushFront inserts a new element e with value v at the front of list l and returns e.

			(*LruList[K, V]) PushFrontExpirable(k K, v V, expiresAt time.Time) *Entry[K, V]
				PushFrontExpirable inserts a new expirable element e with Value v at the front of list l and returns e.

			(*LruList[K, V]) Remove(e *Entry[K, V]) V
				Remove removes e from its list, decrements l.len

		As Outputs Of (at least 2)
			func NewList[K, V]() *LruList[K, V]
			func (*LruList)[K, V].Init() *LruList[K, V]


Package-Level Functions (only one)

	 func NewList[K, V]() *LruList[K, V]

		Type Parameters:
			K: comparable
			V: any

		NewList returns an initialized list.

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.