Affected by 
Documentation
¶
Index ¶
- type Map
- func (m *Map[K, V]) Delete(key K)
- func (m *Map[K, V]) Load(key K) (value V, ok bool)
- func (m *Map[K, V]) LoadAndDelete(key K) (value V, loaded bool)
- func (m *Map[K, V]) LoadOrStore(key K, value V) (actual V, loaded bool)
- func (m *Map[K, V]) Range(f func(key K, value V) bool)
- func (m *Map[K, V]) Store(key K, value V)
- func (m *Map[K, V]) Swap(key K, value V) (previous V, loaded bool)
- type MapCmpValues
- type Mutex
- type MutexDebug
- type RWMutex
- type RWMutexDebug
- type SemaphoredMutex
- type SortableMutex
- type SortableMutexes
- type StoppableWaitGroup
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Map ¶ added in v1.15.0
type Map[K comparable, V any] sync.Map
Map is a thin generic wrapper around sync.Map. The sync.Map description from the standard library follows (and is also propagated to the corresponding methods) for users' convenience:
Map is like a Go map[interface{}]interface{} but is safe for concurrent use by multiple goroutines without additional locking or coordination. Loads, stores, and deletes run in amortized constant time.
The Map type is specialized. Most code should use a plain Go map instead, with separate locking or coordination, for better type safety and to make it easier to maintain other invariants along with the map content.
The Map type is optimized for two common use cases: (1) when the entry for a given key is only ever written once but read many times, as in caches that only grow, or (2) when multiple goroutines read, write, and overwrite entries for disjoint sets of keys. In these two cases, use of a Map may significantly reduce lock contention compared to a Go map paired with a separate Mutex or RWMutex.
The zero Map is empty and ready for use. A Map must not be copied after first use.
func (*Map[K, V]) Delete ¶ added in v1.15.0
func (m *Map[K, V]) Delete(key K)
Delete deletes the value for a key.
func (*Map[K, V]) Load ¶ added in v1.15.0
Load returns the value stored in the map for a key, or the zero value if no value is present. The ok result indicates whether value was found in the map.
func (*Map[K, V]) LoadAndDelete ¶ added in v1.15.0
LoadAndDelete deletes the value for a key, returning the previous value if any (zero value otherwise). The loaded result reports whether the key was present.
func (*Map[K, V]) LoadOrStore ¶ added in v1.15.0
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[K, V]) Range ¶ added in v1.15.0
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 (including by f), Range may reflect any mapping for that key from any point during the Range call. Range does not block other methods on the receiver; even f itself may call any method on m.
Range may be O(N) with the number of elements in the map even if f returns false after a constant number of calls.
type MapCmpValues ¶ added in v1.15.0
type MapCmpValues[K, V comparable] Map[K, V]
MapCmpValues is an extension of Map, which additionally wraps the two extra methods requiring values to be also of comparable type.
func (*MapCmpValues[K, V]) CompareAndDelete ¶ added in v1.15.0
func (m *MapCmpValues[K, V]) CompareAndDelete(key K, old V) (deleted bool)
CompareAndDelete deletes the entry for key if its value is equal to old. If there is no current value for key in the map, CompareAndDelete returns false (even if the old value is the nil interface value).
func (*MapCmpValues[K, V]) CompareAndSwap ¶ added in v1.15.0
func (m *MapCmpValues[K, V]) CompareAndSwap(key K, old, new V) bool
CompareAndSwap swaps the old and new values for key if the value stored in the map is equal to old.
type Mutex ¶
type Mutex struct {
// contains filtered or unexported fields
}
Mutex is equivalent to sync.Mutex but applies deadlock detection if the built tag "lockdebug" is set
func (*Mutex) UnlockIgnoreTime ¶
func (i *Mutex) UnlockIgnoreTime()
type MutexDebug ¶
MutexDebug is a MutexDebug with deadlock detection regardless of use of the build tag
type RWMutex ¶
type RWMutex struct {
// contains filtered or unexported fields
}
RWMutex is equivalent to sync.RWMutex but applies deadlock detection if the built tag "lockdebug" is set
func (*RWMutex) UnlockIgnoreTime ¶
func (i *RWMutex) UnlockIgnoreTime()
type RWMutexDebug ¶
type RWMutexDebug struct {