Package: github.com/patrickmn/go-cache

package cache Import Path github.com/patrickmn/go-cache (on go.dev) Dependency Relation imports 11 packages, and imported by one package

Involved Source Files cache.go sharded.go

Package-Level Type Names (total 2)

/* sort by: alphabet | popularity */

type Cache (struct) Methods (total 46) ( 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. ( Cache) Decrement(k string, n int64) error Decrement an item of type int, int8, int16, int32, int64, uintptr, uint, uint8, uint32, or uint64, float32 or float64 by n. Returns an error if the item's value is not an integer, if it was not found, or if it is not possible to decrement it by n. To retrieve the decremented value, use one of the specialized methods, e.g. DecrementInt64. ( Cache) DecrementFloat(k string, n float64) error Decrement an item of type float32 or float64 by n. Returns an error if the item's value is not floating point, if it was not found, or if it is not possible to decrement it by n. Pass a negative number to decrement the value. To retrieve the decremented value, use one of the specialized methods, e.g. DecrementFloat64. ( Cache) DecrementFloat32(k string, n float32) (float32, error) Decrement an item of type float32 by n. Returns an error if the item's value is not an float32, or if it was not found. If there is no error, the decremented value is returned. ( Cache) DecrementFloat64(k string, n float64) (float64, error) Decrement an item of type float64 by n. Returns an error if the item's value is not an float64, or if it was not found. If there is no error, the decremented value is returned. ( Cache) DecrementInt(k string, n int) (int, error) Decrement an item of type int by n. Returns an error if the item's value is not an int, or if it was not found. If there is no error, the decremented value is returned. ( Cache) DecrementInt16(k string, n int16) (int16, error) Decrement an item of type int16 by n. Returns an error if the item's value is not an int16, or if it was not found. If there is no error, the decremented value is returned. ( Cache) DecrementInt32(k string, n int32) (int32, error) Decrement an item of type int32 by n. Returns an error if the item's value is not an int32, or if it was not found. If there is no error, the decremented value is returned. ( Cache) DecrementInt64(k string, n int64) (int64, error) Decrement an item of type int64 by n. Returns an error if the item's value is not an int64, or if it was not found. If there is no error, the decremented value is returned. ( Cache) DecrementInt8(k string, n int8) (int8, error) Decrement an item of type int8 by n. Returns an error if the item's value is not an int8, or if it was not found. If there is no error, the decremented value is returned. ( Cache) DecrementUint(k string, n uint) (uint, error) Decrement an item of type uint by n. Returns an error if the item's value is not an uint, or if it was not found. If there is no error, the decremented value is returned. ( Cache) DecrementUint16(k string, n uint16) (uint16, error) Decrement an item of type uint16 by n. Returns an error if the item's value is not an uint16, or if it was not found. If there is no error, the decremented value is returned. ( Cache) DecrementUint32(k string, n uint32) (uint32, error) Decrement an item of type uint32 by n. Returns an error if the item's value is not an uint32, or if it was not found. If there is no error, the decremented value is returned. ( Cache) DecrementUint64(k string, n uint64) (uint64, error) Decrement an item of type uint64 by n. Returns an error if the item's value is not an uint64, or if it was not found. If there is no error, the decremented value is returned. ( Cache) DecrementUint8(k string, n uint8) (uint8, error) Decrement an item of type uint8 by n. Returns an error if the item's value is not an uint8, or if it was not found. If there is no error, the decremented value is returned. ( Cache) DecrementUintptr(k string, n uintptr) (uintptr, error) Decrement an item of type uintptr by n. Returns an error if the item's value is not an uintptr, or if it was not found. If there is no error, the decremented value is returned. ( Cache) Delete(k string) Delete an item from the cache. Does nothing if the key is not in the cache. ( Cache) DeleteExpired() Delete all expired items from the cache. ( Cache) Flush() Delete all items from the cache. ( 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. ( 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. ( Cache) Increment(k string, n int64) error Increment an item of type int, int8, int16, int32, int64, uintptr, uint, uint8, uint32, or uint64, float32 or float64 by n. Returns an error if the item's value is not an integer, if it was not found, or if it is not possible to increment it by n. To retrieve the incremented value, use one of the specialized methods, e.g. IncrementInt64. ( Cache) IncrementFloat(k string, n float64) error Increment an item of type float32 or float64 by n. Returns an error if the item's value is not floating point, if it was not found, or if it is not possible to increment it by n. Pass a negative number to decrement the value. To retrieve the incremented value, use one of the specialized methods, e.g. IncrementFloat64. ( Cache) IncrementFloat32(k string, n float32) (float32, error) Increment an item of type float32 by n. Returns an error if the item's value is not an float32, or if it was not found. If there is no error, the incremented value is returned. ( Cache) IncrementFloat64(k string, n float64) (float64, error) Increment an item of type float64 by n. Returns an error if the item's value is not an float64, or if it was not found. If there is no error, the incremented value is returned. ( Cache) IncrementInt(k string, n int) (int, error) Increment an item of type int by n. Returns an error if the item's value is not an int, or if it was not found. If there is no error, the incremented value is returned. ( Cache) IncrementInt16(k string, n int16) (int16, error) Increment an item of type int16 by n. Returns an error if the item's value is not an int16, or if it was not found. If there is no error, the incremented value is returned. ( Cache) IncrementInt32(k string, n int32) (int32, error) Increment an item of type int32 by n. Returns an error if the item's value is not an int32, or if it was not found. If there is no error, the incremented value is returned. ( Cache) IncrementInt64(k string, n int64) (int64, error) Increment an item of type int64 by n. Returns an error if the item's value is not an int64, or if it was not found. If there is no error, the incremented value is returned. ( Cache) IncrementInt8(k string, n int8) (int8, error) Increment an item of type int8 by n. Returns an error if the item's value is not an int8, or if it was not found. If there is no error, the incremented value is returned. ( Cache) IncrementUint(k string, n uint) (uint, error) Increment an item of type uint by n. Returns an error if the item's value is not an uint, or if it was not found. If there is no error, the incremented value is returned. ( Cache) IncrementUint16(k string, n uint16) (uint16, error) Increment an item of type uint16 by n. Returns an error if the item's value is not an uint16, or if it was not found. If there is no error, the incremented value is returned. ( Cache) IncrementUint32(k string, n uint32) (uint32, error) Increment an item of type uint32 by n. Returns an error if the item's value is not an uint32, or if it was not found. If there is no error, the incremented value is returned. ( Cache) IncrementUint64(k string, n uint64) (uint64, error) Increment an item of type uint64 by n. Returns an error if the item's value is not an uint64, or if it was not found. If there is no error, the incremented value is returned. ( Cache) IncrementUint8(k string, n uint8) (uint8, error) Increment an item of type uint8 by n. Returns an error if the item's value is not an uint8, or if it was not found. If there is no error, the incremented value is returned. ( Cache) IncrementUintptr(k string, n uintptr) (uintptr, error) Increment an item of type uintptr by n. Returns an error if the item's value is not an uintptr, or if it was not found. If there is no error, the incremented value is returned. ( 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. ( Cache) Items() map[string]Item Copies all unexpired items in the cache into a new map and returns it. ( 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().) ( 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().) ( Cache) OnEvicted(f func(string, interface{})) 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. ( 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. ( 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().) ( 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().) ( 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. ( Cache) SetDefault(k string, x interface{}) Add an item to the cache, replacing any existing item, using the default expiration. Implements (at least one exported) Cache : net/http.Flusher As Outputs Of (at least 2) func New(defaultExpiration, cleanupInterval time.Duration) *Cache func NewFrom(defaultExpiration, cleanupInterval time.Duration, items map[string]Item) *Cache

type Item (struct) Fields (total 2) Expiration int64 Object interface{} Methods (only one) ( Item) Expired() bool Returns true if the item has expired. As Inputs Of (at least one exported) func NewFrom(defaultExpiration, cleanupInterval time.Duration, items map[string]Item) *Cache

Package-Level Functions (total 2)

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 NewFrom(defaultExpiration, cleanupInterval time.Duration, items map[string]Item) *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(). 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.

Package-Level Constants (total 2)

const DefaultExpiration time.Duration = 0 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.)

const NoExpiration time.Duration = -1 For use with functions that take an expiration time.