The TtlMap key can now be any comparable data type

Author: jftuga

README.md

@@ -1,7 +1,7 @@
 # TtlMap
 
 `TtlMap` is golang package that implements a *time-to-live* map such that after a given amount of time, items in the map are deleted.
-* The default map key uses a type of `string`, but this can be modified be changing `CustomKeyType` in [TtlMap.go](TtlMap.go).
+* The map key can be any [comparable](https://go.dev/ref/spec#Comparison_operators) data type, via Generics.
 * Any data type can be used as a map value. Internally, `interface{}` is used for this.
 
 ## Example
@@ -24,7 +24,7 @@ func main() {
 	startSize := 3                                  // initial number of items in map
 	pruneInterval := time.Duration(time.Second * 1) // search for expired items every 'pruneInterval' seconds
 	refreshLastAccessOnGet := true                  // update item's 'lastAccessTime' on a .Get()
-	t := TtlMap.New(maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
+	t := TtlMap.New[string](maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
 	defer t.Close()
 
 	// populate the TtlMap
@@ -46,7 +46,6 @@ func main() {
 	fmt.Printf("[%9s] %v\n", "int_array", t.Get("int_array"))
 	fmt.Println("TtlMap length:", t.Len())
 }
-
 ```
 
 Output:

example/example.go

@@ -25,7 +25,7 @@ func main() {
 	startSize := 3                                  // initial number of items in map
 	pruneInterval := time.Duration(time.Second * 1) // search for expired items every 'pruneInterval' seconds
 	refreshLastAccessOnGet := true                  // update item's lastAccessTime on a .Get()
-	t := TtlMap.New(maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
+	t := TtlMap.New[string](maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
 	defer t.Close()
 
 	// populate the TtlMap
@@ -66,7 +66,7 @@ func main() {
 	dontExpireKey := "float"
 	go func() {
 		for range time.Tick(time.Second) {
-			t.Get(TtlMap.CustomKeyType(dontExpireKey))
+			t.Get(dontExpireKey)
 		}
 	}()
 
@@ -99,10 +99,10 @@ func main() {
 
 	fmt.Println()
 	fmt.Printf("Manually deleting '%v' key; should be successful\n", dontExpireKey)
-	success := t.Delete(TtlMap.CustomKeyType(dontExpireKey))
+	success := t.Delete(dontExpireKey)
 	fmt.Printf("    successful? %v\n", success)
 	fmt.Printf("Manually deleting '%v' key again; should NOT be successful this time\n", dontExpireKey)
-	success = t.Delete(TtlMap.CustomKeyType(dontExpireKey))
+	success = t.Delete(dontExpireKey)
 	fmt.Printf("    successful? %v\n", success)
 	fmt.Println("TtlMap length:", t.Len(), " (should equal 0)")
 	fmt.Println()

example/small/small.go

@@ -12,7 +12,7 @@ func main() {
 	startSize := 3                                  // initial number of items in map
 	pruneInterval := time.Duration(time.Second * 1) // search for expired items every 'pruneInterval' seconds
 	refreshLastAccessOnGet := true                  // update item's 'lastAccessTime' on a .Get()
-	t := TtlMap.New(maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
+	t := TtlMap.New[string](maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
 	defer t.Close()
 
 	// populate the TtlMap

ttlMap.go

@@ -9,19 +9,9 @@ in the map are deleted.
 When a Put() occurs, the lastAccess time is set to time.Now().Unix()
 When a Get() occurs, the lastAccess time is updated to time.Now().Unix()
 Therefore, only items that are not called by Get() will be deleted after the TTL occurs.
+A GetNoUpdate() can be used in which case the lastAccess time will NOT be updated.
 
 Adopted from: https://stackoverflow.com/a/25487392/452281
-
-Changes from the referenced implementation
-==========================================
-1) the may key is user definable by setting CustomKeyType (defaults to string)
-2) use interface{} instead of string as the map value so that any data type can be used
-3) added All() function
-4) use item.Value instead of item.value so that it can be externally referenced
-5) added user configurable prune interval - search for expired items every 'pruneInterval' seconds
-6) toggle for refreshLastAccessOnGet - update item's lastAccessTime on a .Get() when set to true
-7) add Delete() and Clear() functions
-
 */
 
 package TtlMap
@@ -34,25 +24,27 @@ import (
 
 const version string = "1.4.0"
 
-type CustomKeyType string
+type CustomKeyType interface {
+	comparable
+}
 
 type item struct {
 	Value      interface{}
 	lastAccess int64
 }
 
-type TtlMap struct {
-	m       map[CustomKeyType]*item
+type TtlMap[T CustomKeyType] struct {
+	m       map[T]*item
 	l       sync.Mutex
 	refresh bool
 	stop    chan bool
 }
 
-func New(maxTTL time.Duration, ln int, pruneInterval time.Duration, refreshLastAccessOnGet bool) (m *TtlMap) {
+func New[T CustomKeyType](maxTTL time.Duration, ln int, pruneInterval time.Duration, refreshLastAccessOnGet bool) (m *TtlMap[T]) {
 	// if pruneInterval > maxTTL {
 	// 	print("WARNING: TtlMap: pruneInterval > maxTTL\n")
 	// }
-	m = &TtlMap{m: make(map[CustomKeyType]*item, ln), stop: make(chan bool)}
+	m = &TtlMap[T]{m: make(map[T]*item, ln), stop: make(chan bool)}
 	m.refresh = refreshLastAccessOnGet
 	maxTTL /= 1000000000
 	// print("maxTTL: ", maxTTL, "\n")
@@ -79,11 +71,11 @@ func New(maxTTL time.Duration, ln int, pruneInterval time.Duration, refreshLastA
 	return
 }
 
-func (m *TtlMap) Len() int {
+func (m *TtlMap[T]) Len() int {
 	return len(m.m)
 }
 
-func (m *TtlMap) Put(k CustomKeyType, v interface{}) {
+func (m *TtlMap[T]) Put(k T, v interface{}) {
 	m.l.Lock()
 	it, ok := m.m[k]
 	if !ok {
@@ -94,7 +86,7 @@ func (m *TtlMap) Put(k CustomKeyType, v interface{}) {
 	m.l.Unlock()
 }
 
-func (m *TtlMap) Get(k CustomKeyType) (v interface{}) {
+func (m *TtlMap[T]) Get(k T) (v interface{}) {
 	m.l.Lock()
 	if it, ok := m.m[k]; ok {
 		v = it.Value
@@ -106,7 +98,7 @@ func (m *TtlMap) Get(k CustomKeyType) (v interface{}) {
 	return
 }
 
-func (m *TtlMap) GetNoUpdate(k CustomKeyType) (v interface{}) {
+func (m *TtlMap[T]) GetNoUpdate(k T) (v interface{}) {
 	m.l.Lock()
 	if it, ok := m.m[k]; ok {
 		v = it.Value
@@ -115,7 +107,7 @@ func (m *TtlMap) GetNoUpdate(k CustomKeyType) (v interface{}) {
 	return
 }
 
-func (m *TtlMap) Delete(k CustomKeyType) bool {
+func (m *TtlMap[T]) Delete(k T) bool {
 	m.l.Lock()
 	_, ok := m.m[k]
 	if !ok {
@@ -127,20 +119,20 @@ func (m *TtlMap) Delete(k CustomKeyType) bool {
 	return true
 }
 
-func (m *TtlMap) Clear() {
+func (m *TtlMap[T]) Clear() {
 	m.l.Lock()
 	clear(m.m)
 	m.l.Unlock()
 }
 
-func (m *TtlMap) All() map[CustomKeyType]*item {
+func (m *TtlMap[T]) All() map[T]*item {
 	m.l.Lock()
-	dst := make(map[CustomKeyType]*item, len(m.m))
+	dst := make(map[T]*item, len(m.m))
 	maps.Copy(dst, m.m)
 	m.l.Unlock()
 	return dst
 }
 
-func (m *TtlMap) Close() {
+func (m *TtlMap[T]) Close() {
 	m.stop <- true
 }

ttlMap_test.go

@@ -11,7 +11,7 @@ func TestAllItemsExpired(t *testing.T) {
 	startSize := 3                                  // initial number of items in map
 	pruneInterval := time.Duration(time.Second * 1) // search for expired items every 'pruneInterval' seconds
 	refreshLastAccessOnGet := true                  // update item's lastAccessTime on a .Get()
-	tm := New(maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
+	tm := New[string](maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
 	defer tm.Close()
 
 	// populate the TtlMap
@@ -30,7 +30,7 @@ func TestNoItemsExpired(t *testing.T) {
 	startSize := 3                                  // initial number of items in map
 	pruneInterval := time.Duration(time.Second * 3) // search for expired items every 'pruneInterval' seconds
 	refreshLastAccessOnGet := true                  // update item's lastAccessTime on a .Get()
-	tm := New(maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
+	tm := New[string](maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
 	defer tm.Close()
 
 	// populate the TtlMap
@@ -49,7 +49,7 @@ func TestKeepFloat(t *testing.T) {
 	startSize := 3                                  // initial number of items in map
 	pruneInterval := time.Duration(time.Second * 1) // search for expired items every 'pruneInterval' seconds
 	refreshLastAccessOnGet := true                  // update item's lastAccessTime on a .Get()
-	tm := New(maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
+	tm := New[string](maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
 	defer tm.Close()
 
 	// populate the TtlMap
@@ -60,7 +60,7 @@ func TestKeepFloat(t *testing.T) {
 	dontExpireKey := "int"
 	go func() {
 		for range time.Tick(time.Second) {
-			tm.Get(CustomKeyType(dontExpireKey))
+			tm.Get(dontExpireKey)
 		}
 	}()
 
@@ -69,19 +69,19 @@ func TestKeepFloat(t *testing.T) {
 		t.Fatalf("t.Len should equal 1, but actually equals %v\n", tm.Len())
 	}
 	all := tm.All()
-	if all[CustomKeyType(dontExpireKey)].Value != 1234 {
-		t.Errorf("Value should equal 1234 but actually equals %v\n", all[CustomKeyType(dontExpireKey)].Value)
+	if all[dontExpireKey].Value != 1234 {
+		t.Errorf("Value should equal 1234 but actually equals %v\n", all[dontExpireKey].Value)
 	}
 	t.Logf("tm.Len: %v\n", tm.Len())
-	t.Logf("%v Value: %v\n", dontExpireKey, all[CustomKeyType(dontExpireKey)].Value)
+	t.Logf("%v Value: %v\n", dontExpireKey, all[dontExpireKey].Value)
 }
 
 func TestWithNoRefresh(t *testing.T) {
 	maxTTL := time.Duration(time.Second * 4)        // time in seconds
 	startSize := 3                                  // initial number of items in map
 	pruneInterval := time.Duration(time.Second * 1) // search for expired items every 'pruneInterval' seconds
 	refreshLastAccessOnGet := false                 // do NOT update item's lastAccessTime on a .Get()
-	tm := New(maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
+	tm := New[string](maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
 	defer tm.Close()
 
 	// populate the TtlMap
@@ -107,7 +107,7 @@ func TestDelete(t *testing.T) {
 	startSize := 3                                  // initial number of items in map
 	pruneInterval := time.Duration(time.Second * 4) // search for expired items every 'pruneInterval' seconds
 	refreshLastAccessOnGet := true                  // update item's lastAccessTime on a .Get()
-	tm := New(maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
+	tm := New[string](maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
 	defer tm.Close()
 
 	// populate the TtlMap
@@ -132,7 +132,7 @@ func TestClear(t *testing.T) {
 	startSize := 3                                  // initial number of items in map
 	pruneInterval := time.Duration(time.Second * 4) // search for expired items every 'pruneInterval' seconds
 	refreshLastAccessOnGet := true                  // update item's lastAccessTime on a .Get()
-	tm := New(maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
+	tm := New[string](maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
 	defer tm.Close()
 
 	// populate the TtlMap
@@ -155,7 +155,7 @@ func TestAllFunc(t *testing.T) {
 	startSize := 3                                  // initial number of items in map
 	pruneInterval := time.Duration(time.Second * 4) // search for expired items every 'pruneInterval' seconds
 	refreshLastAccessOnGet := true                  // update item's lastAccessTime on a .Get()
-	tm := New(maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
+	tm := New[string](maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
 	defer tm.Close()
 
 	// populate the TtlMap
@@ -186,7 +186,7 @@ func TestGetNoUpdate(t *testing.T) {
 	startSize := 3                                  // initial number of items in map
 	pruneInterval := time.Duration(time.Second * 4) // search for expired items every 'pruneInterval' seconds
 	refreshLastAccessOnGet := true                  // update item's lastAccessTime on a .Get()
-	tm := New(maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
+	tm := New[string](maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
 	defer tm.Close()
 
 	// populate the TtlMap
@@ -209,3 +209,74 @@ func TestGetNoUpdate(t *testing.T) {
 		t.Errorf("t.Len should be 0, but actually equals %v\n", tm.Len())
 	}
 }
+
+func TestUInt64Key(t *testing.T) {
+	maxTTL := time.Duration(time.Second * 2)        // time in seconds
+	startSize := 3                                  // initial number of items in map
+	pruneInterval := time.Duration(time.Second * 4) // search for expired items every 'pruneInterval' seconds
+	refreshLastAccessOnGet := true                  // update item's lastAccessTime on a .Get()
+	tm := New[uint64](maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
+	defer tm.Close()
+
+	tm.Put(18446744073709551615, "largest")
+	tm.Put(9223372036854776000, "mid")
+	tm.Put(0, "zero")
+
+	allItems := tm.All()
+	for k, v := range allItems {
+		t.Logf("k: %v   v: %v\n", k, v.Value)
+	}
+
+	time.Sleep(maxTTL + pruneInterval)
+	t.Logf("tm.Len: %v\n", tm.Len())
+	if tm.Len() != 0 {
+		t.Errorf("t.Len should be 0, but actually equals %v\n", tm.Len())
+	}
+}
+
+func TestUFloat32Key(t *testing.T) {
+	maxTTL := time.Duration(time.Second * 2)        // time in seconds
+	startSize := 3                                  // initial number of items in map
+	pruneInterval := time.Duration(time.Second * 4) // search for expired items every 'pruneInterval' seconds
+	refreshLastAccessOnGet := true                  // update item's lastAccessTime on a .Get()
+	tm := New[float32](maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
+	defer tm.Close()
+
+	tm.Put(34000000000.12345, "largest")
+	tm.Put(12312312312.98765, "mid")
+	tm.Put(0.001, "tiny")
+
+	allItems := tm.All()
+	for k, v := range allItems {
+		t.Logf("k: %v   v: %v\n", k, v.Value)
+	}
+	t.Logf("k: 0.001   v:%v   (verified)\n", tm.Get(0.001))
+
+	time.Sleep(maxTTL + pruneInterval)
+	t.Logf("tm.Len: %v\n", tm.Len())
+	if tm.Len() != 0 {
+		t.Errorf("t.Len should be 0, but actually equals %v\n", tm.Len())
+	}
+}
+
+func TestByteKey(t *testing.T) {
+	maxTTL := time.Duration(time.Second * 2)        // time in seconds
+	startSize := 3                                  // initial number of items in map
+	pruneInterval := time.Duration(time.Second * 4) // search for expired items every 'pruneInterval' seconds
+	refreshLastAccessOnGet := true                  // update item's lastAccessTime on a .Get()
+	tm := New[byte](maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
+	defer tm.Close()
+
+	tm.Put(0x41, "A")
+	tm.Put(0x7a, "z")
+
+	allItems := tm.All()
+	for k, v := range allItems {
+		t.Logf("k: %x   v: %v\n", k, v.Value)
+	}
+	time.Sleep(maxTTL + pruneInterval)
+	t.Logf("tm.Len: %v\n", tm.Len())
+	if tm.Len() != 0 {
+		t.Errorf("t.Len should be 0, but actually equals %v\n", tm.Len())
+	}
+}