Interface Store<K, T>

Get returns a single element value from the store.

If key is not set, the zero T value is returned.

GetAll returns a shallow copy of the current store data.

GetOk is similar to Get but returns also a boolean indicating whether the key exists or not.

GetOrSet retrieves a single existing value for the provided key or stores a new one if it doesn't exist.

Has checks if element with the specified key exist or not.

Keys returns a slice with all of the store keys.

Length returns the current number of elements in the store.

MarshalJSON implements [json.Marshaler] and export the current store data into valid JSON.

Remove removes a single entry from the store.

Remove does nothing if key doesn't exist in the store.

RemoveAll removes all the existing store entries.

Reset clears the store and replaces the store data with a shallow copy of the provided newData.

Set sets (or overwrite if already exists) a new value for key.

SetFunc sets (or overwrite if already exists) a new value resolved from the function callback for the provided key.

The function callback receives as argument the old store element value (if exists). If there is no old store element, the argument will be the T zero value.

Example:

 s := store.New[string, int](nil)
 s.SetFunc("count", func(old int) int {
     return old + 1
 })
Copy

SetIfLessThanLimit sets (or overwrite if already exist) a new value for key.

This method is similar to Set() but it will skip adding new elements to the store if the store length has reached the specified limit. false is returned if maxAllowedElements limit is reached.

UnmarshalJSON implements [json.Unmarshaler] and imports the provided JSON data into the store.

The store entries that match with the ones from the data will be overwritten with the new value.

Values returns a slice with all of the store values.