cache

README

go-cache-limit

fork of https://github.com/patrickmn/go-cache with items limit

Documentation

Index

• Constants
• type Cache
  • func New(defaultExpiration, cleanupInterval time.Duration) *Cache
  • func NewWithLimit(defaultExpiration, cleanupInterval time.Duration, limit int) *Cache
  • func (c Cache) Add(k string, x interface{}, d time.Duration) error
  • func (c Cache) Delete(k string)
  • func (c Cache) DeleteExceeded()
  • func (c Cache) DeleteExpired()
  • func (c Cache) Flush()
  • func (c Cache) Get(k string) (interface{}, bool)
  • func (c Cache) GetWithExpiration(k string) (interface{}, time.Time, bool)
  • func (c Cache) ItemCount() int
  • func (c Cache) Items() map[string]Item
  • func (c Cache) Replace(k string, x interface{}, d time.Duration) error
  • func (c Cache) Set(k string, x interface{}, d time.Duration)
  • func (c Cache) SetDefault(k string, x interface{})
  • func (c Cache) Touch(k string, d time.Duration) error
• 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) *Cache

Return 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 NewWithLimit

func NewWithLimit(defaultExpiration, cleanupInterval time.Duration, limit int) *Cache

func (Cache) Add

func (c Cache) Add(k string, x interface{}, d time.Duration) error

Add an item to the cache only if an item doesn't already exist for the given key, or if the existing item has expired. Returns an error otherwise.

func (Cache) Delete

func (c Cache) Delete(k string)

Delete an item from the cache. Does nothing if the key is not in the cache.

func (Cache) DeleteExceeded

func (c Cache) DeleteExceeded()

Delete all exceeded items from the cache.

func (Cache) DeleteExpired

func (c Cache) DeleteExpired()

Delete all expired items from the cache.

func (Cache) Flush

func (c Cache) Flush()

Delete all items from the cache.

func (Cache) Get

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

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

func (Cache) GetWithExpiration

func (c Cache) GetWithExpiration(k string) (interface{}, time.Time, bool)

GetWithExpiration returns an item and its expiration time from the cache. It returns the item or nil, the expiration time if one is set (if the item never expires a zero value for time.Time is returned), and a bool indicating whether the key was found.

func (Cache) ItemCount

func (c Cache) ItemCount() int

Returns the number of items in the cache. This may include items that have expired, but have not yet been cleaned up.

func (Cache) Items

func (c Cache) Items() map[string]Item

Copies all unexpired items in the cache into a new map and returns it.

func (Cache) Replace

func (c Cache) Replace(k string, x interface{}, d time.Duration) error

Set a new value for the cache key only if it already exists, and the existing item hasn't expired. Returns an error otherwise.

func (Cache) Set

func (c Cache) Set(k string, 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.

func (Cache) SetDefault

func (c Cache) SetDefault(k string, x interface{})

Add an item to the cache, replacing any existing item, using the default expiration.

func (Cache) Touch

func (c Cache) Touch(k string, d time.Duration) error

Touch a new expiration for the cache key only if it already exists, and the existing item hasn't expired. Returns an error otherwise.

type Item

type Item struct {
	Object     interface{}
	Expiration int64
}

func (Item) Expired

func (item Item) Expired() bool

Returns true if the item has expired.