memory

Documentation

Index

• type Cache
  • func New[T any](opts ...CacheOption[T]) *Cache[T]
  • func NewWithData[T any](data []CacheEntry[T], opts ...CacheOption[T]) *Cache[T]
  • func (c *Cache[T]) Clear()
  • func (c *Cache[T]) Contents() string
  • func (c *Cache[T]) Count() int
  • func (c *Cache[T]) Delete(key string)
  • func (c *Cache[T]) Exists(key string) bool
  • func (c *Cache[T]) Get(key string) (T, bool)
  • func (c *Cache[T]) Keys() []string
  • func (c *Cache[T]) Set(key string, value T)
  • func (c *Cache[T]) Values() []T
• type CacheEntry
• type CacheOption
  • func WithExpirationInterval[T any](interval time.Duration) CacheOption[T]
  • func WithPurgeInterval[T any](interval time.Duration) CacheOption[T]

Types

type Cache

type Cache[T any] struct {
	// contains filtered or unexported fields
}

Cache wraps the go-cache library to provide an in-memory key-value store.

func New

func New[T any](opts ...CacheOption[T]) *Cache[T]

New constructs a new in-memory cache instance with optional configurations. By default, it sets the expiration and purge intervals to 12 and 13 hours, respectively. These defaults can be overridden using the functional options: WithExpirationInterval and WithPurgeInterval.

func NewWithData

func NewWithData[T any](data []CacheEntry[T], opts ...CacheOption[T]) *Cache[T]

NewWithData constructs a new in-memory cache with existing data. It also accepts CacheOption parameters to override default configuration values.

func (*Cache[T]) Clear

func (c *Cache[T]) Clear()

Clear removes all key-value pairs from the cache.

func (*Cache[T]) Contents

func (c *Cache[T]) Contents() string

Contents returns a comma-separated string containing all keys in the cache.

func (*Cache[T]) Count

func (c *Cache[T]) Count() int

Count returns the number of key-value pairs in the cache.

func (*Cache[T]) Delete

func (c *Cache[T]) Delete(key string)

Delete removes the key-value pair from the cache.

func (*Cache[T]) Exists

func (c *Cache[T]) Exists(key string) bool

Exists returns true if the given key exists in the cache.

func (*Cache[T]) Get

func (c *Cache[T]) Get(key string) (T, bool)

Get returns the value for the given key.

func (*Cache[T]) Keys

func (c *Cache[T]) Keys() []string

Keys returns all keys in the cache.

func (*Cache[T]) Set

func (c *Cache[T]) Set(key string, value T)

Set adds a key-value pair to the cache.

func (*Cache[T]) Values

func (c *Cache[T]) Values() []T

Values returns all values in the cache.

type CacheEntry

type CacheEntry[T any] struct {
	// Key is the unique identifier for the entry.
	Key string
	// Value is the data stored in the entry.
	Value T
}

CacheEntry represents a single entry in the cache, consisting of a key and its corresponding value.

type CacheOption

type CacheOption[T any] func(*Cache[T])

CacheOption defines a function type used for configuring a Cache.

func WithExpirationInterval

func WithExpirationInterval[T any](interval time.Duration) CacheOption[T]

WithExpirationInterval returns a CacheOption to set the expiration interval of cache items. The interval determines the duration a cached item remains in the cache before it is expired.

func WithPurgeInterval

func WithPurgeInterval[T any](interval time.Duration) CacheOption[T]

WithPurgeInterval returns a CacheOption to set the interval at which the cache purges expired items. Regular purging helps in freeing up memory by removing stale entries.