cache

Documentation

Overview

Package cache implements a simple in-memory cache.

Index

• type Cache
  • func New() *Cache
  • func NewWithTimeout(timeout time.Duration) *Cache
  • func (c *Cache) Clear()
  • func (c *Cache) Close()
  • func (c *Cache) Delete(key any)
  • func (c *Cache) Exists(key any) bool
  • func (c *Cache) Get(key any) (any, bool)
  • func (c *Cache) Set(key any, value any, timeout time.Duration)

Types

type Cache

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

An in-memory cache.

func New

func New() *Cache

New creates a new cache and returns it.

func NewWithTimeout

func NewWithTimeout(timeout time.Duration) *Cache

NewWithTimeout creates a new cache with a specific timeout for the regular clean up and returns it.

func (*Cache) Clear

func (c *Cache) Clear()

Clear removes all cache keys.

func (*Cache) Close

func (c *Cache) Close()

Close closes the cache and frees allocated resources.

func (*Cache) Delete

func (c *Cache) Delete(key any)

Delete deletes an item from the cache

func (*Cache) Exists

func (c *Cache) Exists(key any) bool

Exists reports wether a key exists

func (*Cache) Get

func (c *Cache) Get(key any) (any, bool)

Get returns an item if it exits and it not stale. It also reports whether the item was found.

func (*Cache) Set

func (c *Cache) Set(key any, value any, timeout time.Duration)

Set stores an item in the cache.

If an item with the same key already exists it will be overwritten. An item with timeout = 0 never expires