cache

Documentation

Overview

Package cache implements a capped-size in-memory cache that randomly evicts elements when it reaches max size.

Index

• Constants
• type Cache
  • func New(defaultExpiration, cleanupInterval time.Duration, maxSize int) *Cache
  • func (c Cache) Delete(k interface{})
  • func (c Cache) DeleteExpired()
  • func (c Cache) Get(k interface{}) (interface{}, bool)
  • func (c Cache) Set(k, x interface{}, d time.Duration)
• type Item
  • func (item Item) Expired() bool

Constants

const (
	// For use with functions that take an expiration time.
	NoExpiration time.Duration = -1
	// For use with functions that take an expiration time. Equivalent to
	// passing in the same expiration duration as was given to New() or
	// NewFrom() when the cache was created (e.g. 5 minutes.)
	DefaultExpiration time.Duration = 0
)

Types

type Cache

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

func New

func New(defaultExpiration, cleanupInterval time.Duration, maxSize int) *Cache

New returns a new cache with a given default expiration duration and cleanup interval. If the expiration duration is less than one (or NoExpiration), the items in the cache never expire (by default), and must be deleted manually. If the cleanup interval is less than one, expired items are not deleted from the cache before calling c.DeleteExpired().

func (Cache) Delete

func (c Cache) Delete(k interface{})

Delete the specified key from the cache.

func (Cache) DeleteExpired

func (c Cache) DeleteExpired()

Delete all expired items from the cache.

func (Cache) Get

func (c Cache) Get(k interface{}) (interface{}, bool)

Get an item from the cache. Returns the item or nil, and a bool indicating whether the key was found.

func (Cache) Set

func (c Cache) Set(k, x interface{}, d time.Duration)

Add an item to the cache, replacing any existing item. If the duration is 0 (DefaultExpiration), the cache's default expiration time is used. If it is -1 (NoExpiration), the item never expires.

type Item

type Item struct {
	Object     interface{}
	Expiration int64
}

func (Item) Expired

func (item Item) Expired() bool

Returns true if the item has expired.