Documentation
¶
Index ¶
- type TypedSyncMap
- func (m *TypedSyncMap[K, V]) Clear()
- func (m *TypedSyncMap[K, V]) CompareAndDelete(key K, old V) (deleted bool)
- func (m *TypedSyncMap[K, V]) CompareAndSwap(key K, old V, new V) (swapped bool)
- func (m *TypedSyncMap[K, V]) Delete(key K)
- func (m *TypedSyncMap[K, V]) Load(key K) (value V, ok bool)
- func (m *TypedSyncMap[K, V]) LoadAndDelete(key K) (value V, loaded bool)
- func (m *TypedSyncMap[K, V]) LoadOrStore(key K, value V) (actual V, loaded bool)
- func (m *TypedSyncMap[K, V]) Range(f func(key K, value V) bool)
- func (m *TypedSyncMap[K, V]) Store(key K, value V)
- func (m *TypedSyncMap[K, V]) Swap(key K, value V) (previous V, loaded bool)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type TypedSyncMap ¶
type TypedSyncMap[K, V any] struct { // contains filtered or unexported fields }
TypedSyncMap is a wrapper of sync.Map that provides type-safe for keys and values. No need to use type assertions every time, so you can have more time to enjoy other things like GochiUsa If sync.Map methods returned nil, it will return the zero value of the type V.
func NewTypedSyncMap ¶
func NewTypedSyncMap[K any, V any]() *TypedSyncMap[K, V]
NewTypedSyncMap creates a new TypedSyncMap K is key type, V is value type It is recommended to use pointer types for V because sync.Map might return nil If sync.Map methods really returned nil, it will return the zero value of the type V
func (*TypedSyncMap[K, V]) Clear ¶
func (m *TypedSyncMap[K, V]) Clear()
Clear deletes all the entries, resulting in an empty Map.
func (*TypedSyncMap[K, V]) CompareAndDelete ¶
func (m *TypedSyncMap[K, V]) CompareAndDelete(key K, old V) (deleted bool)
CompareAndDelete deletes the entry for key if its value is equal to old. The old value must be of a comparable type.
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 (*TypedSyncMap[K, V]) CompareAndSwap ¶
func (m *TypedSyncMap[K, V]) CompareAndSwap(key K, old V, new V) (swapped bool)
CompareAndSwap swaps the old and new values for key if the value stored in the map is equal to old. The old value must be of a comparable type.
func (*TypedSyncMap[K, V]) Delete ¶
func (m *TypedSyncMap[K, V]) Delete(key K)
Delete deletes the value for a key.
func (*TypedSyncMap[K, V]) Load ¶
func (m *TypedSyncMap[K, V]) Load(key K) (value V, 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 (*TypedSyncMap[K, V]) LoadAndDelete ¶
func (m *TypedSyncMap[K, V]) LoadAndDelete(key K) (value V, loaded bool)
LoadAndDelete deletes the value for a key, returning the previous value if any. The loaded result reports whether the key was present.
func (*TypedSyncMap[K, V]) LoadOrStore ¶
func (m *TypedSyncMap[K, V]) LoadOrStore(key K, value V) (actual V, 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 (*TypedSyncMap[K, V]) Range ¶
func (m *TypedSyncMap[K, V]) Range(f func(key K, value V) 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 (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.
func (*TypedSyncMap[K, V]) Store ¶
func (m *TypedSyncMap[K, V]) Store(key K, value V)
Store sets the value for a key.
func (*TypedSyncMap[K, V]) Swap ¶
func (m *TypedSyncMap[K, V]) Swap(key K, value V) (previous V, loaded bool)
Swap swaps the value for a key and returns the previous value if any. The loaded result reports whether the key was present.
Source Files