cache

Documentation

Overview

Package cache holds definition of Cache used for storing and retrieving data.

Index

• Variables
• type Cache
• type DefaultCache
  • func New() *DefaultCache
  • func (c *DefaultCache) All() map[string]interface{}
  • func (c *DefaultCache) GetSaved(key string) (interface{}, error)
  • func (c *DefaultCache) Reset()
  • func (c *DefaultCache) Save(key string, value interface{})

Variables

var ErrMissingKey = errors.New("missing key")

ErrMissingKey occurs when cache doesn't have any value under given key.

Types

type Cache

type Cache interface {
	// Save preserve provided value under given key.
	Save(key string, value interface{})

	// GetSaved retrieve value from given key.
	GetSaved(key string) (interface{}, error)

	// Reset turns cache into init state - clears all entries.
	Reset()

	// All returns all cache entries.
	All() map[string]interface{}
}

Cache is entity that has ability to store/retrieve arbitrary values.

type DefaultCache

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

DefaultCache is entity that has ability to store and retrieve arbitrary values.

func New

func New() *DefaultCache

func (*DefaultCache) All

func (c *DefaultCache) All() map[string]interface{}

All returns all current cache data.

func (*DefaultCache) GetSaved

func (c *DefaultCache) GetSaved(key string) (interface{}, error)

GetSaved returns preserved value if present, error otherwise.

func (*DefaultCache) Reset

func (c *DefaultCache) Reset()

Reset turns cache into initial state - - clears all entries.

func (*DefaultCache) Save

func (c *DefaultCache) Save(key string, value interface{})

Save preserve value under given key in DefaultCache.