atomicMap

Documentation

Overview

atomicMap is a seed based on sync.Map in the stdlib.

Index

• type KT
• type MapKTVT
  • func (m *MapKTVT) Delete(key KT)
  • func (m *MapKTVT) Load(key KT) (value VT, ok bool)
  • func (m *MapKTVT) LoadOrStore(key KT, value VT) (actual VT, loaded bool)
  • func (m *MapKTVT) Range(f func(key KT, value VT) bool)
  • func (m *MapKTVT) Store(key KT, value VT)
• type VT

Types

type KT

type KT interface{}

type MapKTVT

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

MapKTVT is a concurrent map with amortized-constant-time loads, stores, and deletes. It is safe for multiple goroutines to call a MapKTVT's methods concurrently.

It is optimized for use in concurrent loops with keys that are stable over time, and either few steady-state stores, or stores localized to one goroutine per key.

For use cases that do not share these attributes, it will likely have comparable or worse performance and worse type safety than an ordinary map paired with a read-write mutex.

The nil MapKTVT is valid and empty.

A MapKTVT must not be copied after first use.

func (*MapKTVT) Delete

func (m *MapKTVT) Delete(key KT)

Delete deletes the value for a key.

func (*MapKTVT) Load

func (m *MapKTVT) Load(key KT) (value VT, ok bool)

Load returns the value stored in the map for a key, or nil if no value is present. The ok result indicates whether value was found in the map.

func (*MapKTVT) LoadOrStore

func (m *MapKTVT) LoadOrStore(key KT, value VT) (actual VT, loaded bool)

LoadOrStore returns the existing value for the key if present. Otherwise, it stores and returns the given value. The loaded result is true if the value was loaded, false if stored.

func (*MapKTVT) Range

func (m *MapKTVT) Range(f func(key KT, value VT) bool)

Range calls f sequentially for each key and value present in the map. If f returns false, range stops the iteration.

Range does not necessarily correspond to any consistent snapshot of the Map's contents: no key will be visited more than once, but if the value for any key is stored or deleted concurrently, Range may reflect any mapping for that key from any point during the Range call.

Range may be O(N) with the number of elements in the map even if f returns false after a constant number of calls.

func (*MapKTVT) Store

func (m *MapKTVT) Store(key KT, value VT)

Store sets the value for a key.

type VT

type VT interface{}