safesync

package
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 9, 2023 License: Apache-2.0, MIT Imports: 1 Imported by: 0

Documentation

Overview

package safesync provides a type-safe, concurrency-safe Map struct

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Map

type Map[T any] struct {
	// contains filtered or unexported fields
}

Map wraps sync.Map in order to provide type safety. The supplied type parameter T applies to the values in the map (not the keys).

func (*Map[T]) Delete

func (o *Map[T]) Delete(key string)

Delete deletes the value for a key.

func (*Map[T]) Load

func (o *Map[T]) Load(id string) (value T, 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[T]) LoadOrStore

func (o *Map[T]) LoadOrStore(key string, value T) (actual T, 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[T]) Range

func (o *Map[T]) Range(f func(key string, value T) 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[T]) Store

func (o *Map[T]) Store(key string, data T)

Store sets the value for a key.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL