timap

README

Timap

Different map implementations

• Timap is a wrapper over sync.Map that allows to set life time for each key-value pair.
• CtxMap allows storing key/value pairs with context to be deleted once the context is cancelled or its deadline is exceeded.

Documentation

Index

• type CtxMap
  • func NewCtxMap() CtxMap
• type Timap
  • func New(lifeTime time.Duration) Timap

Types

type CtxMap

type CtxMap interface {
	Load(key interface{}) (value interface{}, ok bool)
	Store(ctx context.Context, key, value interface{}, callbacks ...func())
	Delete(key interface{})
	Range(f func(key, value interface{}) bool)
}

CtxMap stores provided key/value pairs with context.

func NewCtxMap

func NewCtxMap() CtxMap

NewCtxMap create a new map that stores key/value pairs with provided context. The pair is available until parent context is cancelled, or its deadline exceeds.

type Timap

type Timap interface {
	Load(key interface{}) (value interface{}, ok bool)
	Store(key, value interface{}, lifeTime ...time.Duration)
	Delete(key interface{})
	Range(f func(key, value interface{}) bool)
}

Timap represents "time map", it is a wrapper over sync.Map that allows to store key-value pairs for certain period of time. Default duration can be defined for all key-value pairs in the constructor func, but it is also possible to define custom life time for each pair separately. Watcher will create a goroutine for every temporrary pair. Try not to use it with huge maps.

func New

func New(lifeTime time.Duration) Timap

New is a Timap constructor func. If lifeTime == 0 key-value pairs will not have any time limits (by default), values still can be deleted by calling Delete().