lru

Documentation

Overview

Copyright 2020 New Relic Corporation. All rights reserved. SPDX-License-Identifier: Apache-2.0 Package lru implements an LRU cache. It is based on Google Groupcache's LRU implementation, distributed under Apache License 2.0 in the following repository: https://github.com/golang/groupcache

Index

• type Cache
  • func New() *Cache
  • func (c *Cache) Add(key Key, value interface{})
  • func (c *Cache) Clear()
  • func (c *Cache) Get(key Key) (value interface{}, ok bool)
  • func (c *Cache) Len() int
  • func (c *Cache) Remove(key Key)
  • func (c *Cache) RemoveOldest()
  • func (c *Cache) RemoveUntilLen(newLength int)
• type Key

Types

type Cache

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

Cache is an LRU cache. It is not safe for concurrent access. This cache is not limited in size, but allows resizing it by means of the RemoveUntilLen(int) function

func New

func New() *Cache

New creates a new Cache. The cache has no limit and it's assumed that eviction is done by the caller.

func (*Cache) Add

func (c *Cache) Add(key Key, value interface{})

Add adds a value to the cache.

func (*Cache) Clear

func (c *Cache) Clear()

Clear purges all stored items from the cache.

func (*Cache) Get

func (c *Cache) Get(key Key) (value interface{}, ok bool)

Get looks up a key's value from the cache.

func (*Cache) Len

func (c *Cache) Len() int

Len returns the number of items in the cache.

func (*Cache) Remove

func (c *Cache) Remove(key Key)

Remove removes the provided key from the cache.

func (*Cache) RemoveOldest

func (c *Cache) RemoveOldest()

RemoveOldest removes the oldest item from the cache.

func (*Cache) RemoveUntilLen

func (c *Cache) RemoveUntilLen(newLength int)

RemoveUntilLen removes the oldest entries until the cache reaches the given length.

type Key

type Key interface{}

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