cache

Documentation

Overview

Package cache provides a simple, concurrent-safe in-memory cache with expiration support.

Package cache provides a simple, concurrent-safe in-memory cache with expiration support.

Index

• type Cache
  • func New(defaultDuration time.Duration) *Cache
  • func (cache *Cache) Delete(key string)
  • func (cache *Cache) DeleteExpired()
  • func (cache *Cache) Get(key string) (any, bool)
  • func (cache *Cache) Set(key string, value any, duration time.Duration)
• type GenericCache
  • func NewGeneric[K comparable, V any](defaultDuration time.Duration) *GenericCache[K, V]
  • func (cache *GenericCache[K, V]) Delete(key K)
  • func (cache *GenericCache[K, V]) DeleteExpired()
  • func (cache *GenericCache[K, V]) Get(key K) (V, bool)
  • func (cache *GenericCache[K, V]) Set(key K, value V, duration time.Duration)

Types

type Cache

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

Cache stores arbitrary data with expiration time.

func New

func New(defaultDuration time.Duration) *Cache

New creates a new cache that asynchronously cleans expired entries after the given time passes.

func (*Cache) Delete

func (cache *Cache) Delete(key string)

Delete deletes the key and its value from the cache.

func (*Cache) DeleteExpired

func (cache *Cache) DeleteExpired()

func (*Cache) Get

func (cache *Cache) Get(key string) (any, bool)

Get gets the value for the given key.

func (*Cache) Set

func (cache *Cache) Set(key string, value any, duration time.Duration)

Set sets a value for the given key with an expiration duration. If the duration is less than 0, it will be stored forever. If the duration is 0, the default expiration time will be used

type GenericCache

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

GenericCache stores arbitrary data with expiration time.

func NewGeneric

func NewGeneric[K comparable, V any](defaultDuration time.Duration) *GenericCache[K, V]

NewGeneric creates a new cache that asynchronously cleans expired entries after the given time passes.

func (*GenericCache[K, V]) Delete

func (cache *GenericCache[K, V]) Delete(key K)

Delete deletes the key and its value from the cache.

func (*GenericCache[K, V]) DeleteExpired

func (cache *GenericCache[K, V]) DeleteExpired()

DeleteExpired deletes all expired items from the cache.

func (*GenericCache[K, V]) Get

func (cache *GenericCache[K, V]) Get(key K) (V, bool)

Get gets the value for the given key.

func (*GenericCache[K, V]) Set

func (cache *GenericCache[K, V]) Set(key K, value V, duration time.Duration)

Set sets a value for the given key with an expiration duration. If the duration is less than 0, it will be stored forever. If the duration is 0, the default expiration time will be used