package syncmap

import "golang.org/x/sync/syncmap"

Package syncmap provides a concurrent map implementation. It is a prototype for a proposed addition to the sync package in the standard library. (https://golang.org/issue/18177)

Index ¶

• type Map
• func (m *Map) Delete(key interface{})
• func (m *Map) Load(key interface{}) (value interface{}, ok bool)
• func (m *Map) LoadOrStore(key, value interface{}) (actual interface{}, loaded bool)
• func (m *Map) Range(f func(key, value interface{}) bool)
• func (m *Map) Store(key, value interface{})

Package Files ¶

map.go

type Map ¶ Uses

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

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

The zero Map is valid and empty.

A Map must not be copied after first use.

func (*Map) Delete ¶ Uses

func (m *Map) Delete(key interface{})

Delete deletes the value for a key.

func (*Map) Load ¶ Uses

func (m *Map) Load(key interface{}) (value interface{}, 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 (*Map) LoadOrStore ¶ Uses

func (m *Map) LoadOrStore(key, value interface{}) (actual interface{}, 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 (*Map) Range ¶ Uses

func (m *Map) Range(f func(key, value interface{}) 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 (*Map) Store ¶ Uses

func (m *Map) Store(key, value interface{})

Store sets the value for a key.