cache

package module

v0.1.0 Latest Latest Go to latest Published: Aug 4, 2016 License: MPL-2.0 Imports: 4 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Hearst-DD/cache

Links

Open Source Insights

README ¶

cache: Go LRU cache package

This package is based on https://github.com/hashicorp/golang-lru which is in turn based on the LRU implementation in Brad Fitz's Groupcache package.

Documentation ¶

Index ¶

type Cache
type LRUCache
- func NewLRUCache(size int) (*LRUCache, error)
type Result

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Cache ¶

type Cache interface {

	// Put an object into the cache and expire after the given ttl
	Put(key string, value interface{}, ttl time.Duration)

	// Get an object from the cache. Stale objects are returned, but marked as stale
	Get(key string) (value interface{}, status Result)

	// Size returns the max items that may be stored in the cache
	Size() int
}

Cache is the abstract interface for a cache that requires an TTL duration for objects

func NOOPCache ¶

func NOOPCache() Cache

func New ¶

func New(maxSize int) Cache

New constructs a new LRU/TTL cache with the given max size (num objects)

func WriteOnly ¶

func WriteOnly(c Cache) Cache

WriteOnly wraps a cache in a write-only wrapper (Get() always returns null)

type LRUCache ¶

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

Cache is a thread-safe fixed size LRU cache.

func NewLRUCache ¶

func NewLRUCache(size int) (*LRUCache, error)

NewLRUCache creates an LRU of the given size

func (*LRUCache) Add ¶

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

Add adds a value to the cache.

func (*LRUCache) Get ¶

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

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

func (*LRUCache) Len ¶

func (c *LRUCache) Len() int

Len returns the number of items in the cache.

func (*LRUCache) Purge ¶

func (c *LRUCache) Purge()

Purge is used to completely clear the cache

func (*LRUCache) Remove ¶

func (c *LRUCache) Remove(key interface{})

Remove removes the provided key from the cache.

func (*LRUCache) RemoveOldest ¶

func (c *LRUCache) RemoveOldest()

RemoveOldest removes the oldest item from the cache.

type Result ¶

type Result string

Result is the code of a cache Get operation

const (
	// OK : object for key found and fresh
	OK Result = "ok"
	// NotFound : object for key not found
	NotFound Result = "not found"
	// Stale : object for key found, but stale
	Stale Result = "stale"
)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mocks

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL