gocache

README

gocache

This library is a fork of patrickmn/go-cache enhanced with the support for Go's new generics feature introduced in Go 1.18. Gocache with Generics provides a simple and effective in-memory cache solution while leveraging the type safety and other advantages brought by generics.

Installation

go get github.com/graydovee/gocache/v3

Feature

• Type-safe caching with Go generics.
• Simple API for setting, getting, and deleting values.
• Optional expiration for cached values.

Requirements

• Go version 1.18 or higher.

Usage

import (
    "github.com/graydovee/gocache/v3"
    "time"
)

func main() {
    // Create a cache with a default expiration time of 5 minutes, and which
    // purges expired items every 10 minutes
    c := gocache.New[string, int](5*time.Minute, 10*time.Minute)

    // Set the value of the key "foo" to 41, with the default expiration time
    c.Set("foo", 41, gocache.DefaultExpiration)

    // Set the value of the key "baz" to 42, with no expiration time
    // (the item won't be removed until it is re-set, or removed using
    // c.Delete("baz")
    c.Set("baz", 42, gocache.NoExpiration)
	
    // Get a value from the cache
    baz, found := c.Get("baz")
    if found {
        println(baz)
    }
	
    // Add the value of the key "baz" by 1, now the value of "baz" is 44
    gocache.Increment(c, "baz", 2)

    // Subtract the value of the key "baz" by 1, now the value of "baz" is 43
    gocache.Decrement(c, "baz", 1)
	
    // Delete a value from the cache
    c.Delete("baz")
}

Documentation

Index

• Constants
• func Decrement[K comparable, V Number](c *Cache[K, V], k K, v V) bool
• func Increment[K comparable, V Number](c *Cache[K, V], k K, v V) bool
• type Cache
  • func New[K comparable, V any](defaultExpiration, cleanupInterval time.Duration) *Cache[K, V]
  • func NewFrom[K comparable, V any](defaultExpiration, cleanupInterval time.Duration, items map[K]Item[V]) *Cache[K, V]
  • func (c Cache) Add(k K, x V, d time.Duration) error
  • func (c Cache) Delete(k K)
  • func (c Cache) DeleteExpired()
  • func (c Cache) Flush()
  • func (c Cache) Get(k K) (V, bool)
  • func (c Cache) GetWithExpiration(k K) (V, time.Time, bool)
  • func (c Cache) ItemCount() int
  • func (c Cache) Items() map[K]Item[V]
  • func (c Cache) Load(r io.Reader) error
  • func (c Cache) LoadFile(fname string) error
  • func (c Cache) OnEvicted(f func(K, V))
  • func (c Cache) Replace(k K, x V, d time.Duration) error
  • func (c Cache) Save(w io.Writer) (err error)
  • func (c Cache) SaveFile(fname string) error
  • func (c Cache) Set(k K, x V, d time.Duration)
  • func (c Cache) SetDefault(k K, x V)
• type Item
  • func (item Item[T]) Expired() bool
• type Number

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
)

Functions

func Decrement

func Decrement[K comparable, V Number](c *Cache[K, V], k K, v V) bool

func Increment

func Increment[K comparable, V Number](c *Cache[K, V], k K, v V) bool

Types

type Cache

type Cache[K comparable, V any] struct {
	// contains filtered or unexported fields
}

func New

func New[K comparable, V any](defaultExpiration, cleanupInterval time.Duration) *Cache[K, V]

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 NewFrom

func NewFrom[K comparable, V any](defaultExpiration, cleanupInterval time.Duration, items map[K]Item[V]) *Cache[K, V]

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().

NewFrom() also accepts an items map which will serve as the underlying map for the cache. This is useful for starting from a deserialized cache (serialized using e.g. gob.Encode() on c.Items()), or passing in e.g. make(map[string]Item, 500) to improve startup performance when the cache is expected to reach a certain minimum size.

Only the cache's methods synchronize access to this map, so it is not recommended to keep any references to the map around after creating a cache. If need be, the map can be accessed at a later point using c.Items() (subject to the same caveat.)

Note regarding serialization: When using e.g. gob, make sure to gob.Register() the individual types stored in the cache before encoding a map retrieved with c.Items(), and to register those same types before decoding a blob containing an items map.

func (Cache) Add

func (c Cache) Add(k K, x V, 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 K)

Delete an item from the cache. Does nothing if the key is not in 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 K) (V, 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 K) (V, 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[K]Item[V]

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

func (Cache) Load

func (c Cache) Load(r io.Reader) error

Add (Gob-serialized) cache items from an io.Reader, excluding any items with keys that already exist (and haven't expired) in the current cache.

NOTE: This method is deprecated in favor of c.Items() and NewFrom() (see the documentation for NewFrom().)

func (Cache) LoadFile

func (c Cache) LoadFile(fname string) error

Load and add cache items from the given filename, excluding any items with keys that already exist in the current cache.

NOTE: This method is deprecated in favor of c.Items() and NewFrom() (see the documentation for NewFrom().)

func (Cache) OnEvicted

func (c Cache) OnEvicted(f func(K, V))

Sets an (optional) function that is called with the key and value when an item is evicted from the cache. (Including when it is deleted manually, but not when it is overwritten.) Set to nil to disable.

func (Cache) Replace

func (c Cache) Replace(k K, x V, 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) Save

func (c Cache) Save(w io.Writer) (err error)

Write the cache's items (using Gob) to an io.Writer.

NOTE: This method is deprecated in favor of c.Items() and NewFrom() (see the documentation for NewFrom().)

func (Cache) SaveFile

func (c Cache) SaveFile(fname string) error

Save the cache's items to the given filename, creating the file if it doesn't exist, and overwriting it if it does.

NOTE: This method is deprecated in favor of c.Items() and NewFrom() (see the documentation for NewFrom().)

func (Cache) Set

func (c Cache) Set(k K, x V, 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 K, x V)

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

type Item

type Item[T any] struct {
	Object     T
	Expiration int64
}

func (Item[T]) Expired

func (item Item[T]) Expired() bool

Returns true if the item has expired.

type Number

type Number interface {
	int | int8 | int16 | int32 | int64 | uint | uint8 | uint16 | uint32 | uint64 | float32 | float64
}