vermap

Documentation

Overview

Package vermap implements a key value map like used in session variables.

Index

• type VerMap
  • func NewVerMap() *VerMap
  • func (vm *VerMap) Compare(m map[string]string) (upd map[string]string, del map[string]bool)
  • func (vm *VerMap) CompareWithRLock(m map[string]string) (upd map[string]string, del map[string]bool)
  • func (vm *VerMap) Load() map[string]string
  • func (vm *VerMap) LoadWithRLock() map[string]string
  • func (vm *VerMap) Store(m map[string]string)
  • func (vm *VerMap) Version() int64
  • func (vm *VerMap) WithRLock(f func())

Types

type VerMap

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

A VerMap is a simple map[string]string keeping track changes via a version number. It is safe for concurrent use by multiple goroutines.

func NewVerMap

func NewVerMap() *VerMap

NewVerMap returns a new VerMap instance.

func (*VerMap) Compare

func (vm *VerMap) Compare(m map[string]string) (upd map[string]string, del map[string]bool)

Compare returns the changes (updates and deletes) in VarMap compared to map parameter m.

func (*VerMap) CompareWithRLock

func (vm *VerMap) CompareWithRLock(m map[string]string) (upd map[string]string, del map[string]bool)

CompareWithRLock - same as Compare but needs to be executed in the context of method WithRLock.

func (*VerMap) Load

func (vm *VerMap) Load() map[string]string

Load returns the content of a VarMap as string key value map.

func (*VerMap) LoadWithRLock

func (vm *VerMap) LoadWithRLock() map[string]string

LoadWithRLock - same as Load but needs to be executed in the context of method WithRLock.

func (*VerMap) Store

func (vm *VerMap) Store(m map[string]string)

Store stores a string key value map in VarMap.

func (*VerMap) Version

func (vm *VerMap) Version() int64

Version returns the VarMap version.

func (*VerMap) WithRLock

func (vm *VerMap) WithRLock(f func())

WithRLock executes function f under a read lock.