Replace interface{} with any

README.md

@@ -36,8 +36,8 @@ Features
 
 ```go
 type Store interface {
-    Set(k string, v interface{}) error
-    Get(k string, v interface{}) (found bool, err error)
+    Set(k string, v any) error
+    Get(k string, v any) (found bool, err error)
     Delete(k string) error
     Close() error
 }
@@ -103,7 +103,7 @@ For the Godoc of specific implementations, see <https://pkg.go.dev/github.com/ph
 
 ### Value types
 
-Most Go packages for key-value stores just accept a `[]byte` as value, which requires developers for example to marshal (and later unmarshal) their structs. `gokv` is meant to be simple and make developers' lifes easier, so it accepts any type (with using `interface{}` as parameter), including structs, and automatically (un-)marshals the value.
+Most Go packages for key-value stores just accept a `[]byte` as value, which requires developers for example to marshal (and later unmarshal) their structs. `gokv` is meant to be simple and make developers' lifes easier, so it accepts any type (with using `any`/`interface{}` as parameter), including structs, and automatically (un-)marshals the value.
 
 The kind of (un-)marshalling is left to the implementation. All implementations in this repository currently support JSON and [gob](https://blog.golang.org/gobs-of-data) by using the `encoding` subpackage in this repository, which wraps the core functionality of the standard library's `encoding/json` and `encoding/gob` packages. See [Marshal formats](#marshal-formats) for details.
 
@@ -249,9 +249,9 @@ Project status
 
 Planned interface methods until `v1.0.0`:
 
-- `List(interface{}) error` / `GetAll(interface{}) error` or similar
+- `List(any) error` / `GetAll(any) error` or similar
 
-The interface might even change until `v1.0.0`. For example one consideration is to change `Get(string, interface{}) (bool, error)` to `Get(string, interface{}) error` (no boolean return value anymore), with the `error` being something like `gokv.ErrNotFound // "Key-value pair not found"` to fulfill the additional role of indicating that the key-value pair wasn't found. But at the moment we prefer the current method signature.
+The interface might even change until `v1.0.0`. For example one consideration is to change `Get(string, any) (bool, error)` to `Get(string, any) error` (no boolean return value anymore), with the `error` being something like `gokv.ErrNotFound // "Key-value pair not found"` to fulfill the additional role of indicating that the key-value pair wasn't found. But at the moment we prefer the current method signature.
 
 Also, more interfaces might be added. For example so that there's a `SimpleStore` and an `AdvancedStore`, with the first one containing only the basic methods and the latter one with advanced features such as key-value pair lifetimes (deletion of key-value pairs after a given time), notification of value changes via Go channels etc. But currently the focus is simplicity, see [Design decisions](#design-decisions).
 

badgerdb/badgerdb.go

@@ -16,7 +16,7 @@ type Store struct {
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.
-func (s Store) Set(k string, v interface{}) error {
+func (s Store) Set(k string, v any) error {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return err
 	}
@@ -42,7 +42,7 @@ func (s Store) Set(k string, v interface{}) error {
 // that v points to with the values of the retrieved object's values.
 // If no value is found it returns (false, nil).
 // The key must not be "" and the pointer must not be nil.
-func (s Store) Get(k string, v interface{}) (found bool, err error) {
+func (s Store) Get(k string, v any) (found bool, err error) {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return false, err
 	}

badgerdb/badgerdb_test.go

@@ -118,7 +118,7 @@ func TestNil(t *testing.T) {
 				t.Error("An error was expected")
 			}
 
-			var i interface{} // actually nil
+			var i any // actually nil
 			_, err = store.Get("foo", i)
 			if err == nil {
 				t.Error("An error was expected")

bbolt/bbolt.go

@@ -17,7 +17,7 @@ type Store struct {
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.
-func (s Store) Set(k string, v interface{}) error {
+func (s Store) Set(k string, v any) error {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return err
 	}
@@ -44,7 +44,7 @@ func (s Store) Set(k string, v interface{}) error {
 // that v points to with the values of the retrieved object's values.
 // If no value is found it returns (false, nil).
 // The key must not be "" and the pointer must not be nil.
-func (s Store) Get(k string, v interface{}) (found bool, err error) {
+func (s Store) Get(k string, v any) (found bool, err error) {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return false, err
 	}

bbolt/bbolt_test.go

@@ -118,7 +118,7 @@ func TestNil(t *testing.T) {
 				t.Error("An error was expected")
 			}
 
-			var i interface{} // actually nil
+			var i any // actually nil
 			_, err = store.Get("foo", i)
 			if err == nil {
 				t.Error("An error was expected")

bigcache/bigcache.go

@@ -18,7 +18,7 @@ type Store struct {
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.
-func (s Store) Set(k string, v interface{}) error {
+func (s Store) Set(k string, v any) error {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return err
 	}
@@ -37,7 +37,7 @@ func (s Store) Set(k string, v interface{}) error {
 // that v points to with the values of the retrieved object's values.
 // If no value is found it returns (false, nil).
 // The key must not be "" and the pointer must not be nil.
-func (s Store) Get(k string, v interface{}) (found bool, err error) {
+func (s Store) Get(k string, v any) (found bool, err error) {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return false, err
 	}

bigcache/bigcache_test.go

@@ -113,7 +113,7 @@ func TestNil(t *testing.T) {
 				t.Error("An error was expected")
 			}
 
-			var i interface{} // actually nil
+			var i any // actually nil
 			_, err = store.Get("foo", i)
 			if err == nil {
 				t.Error("An error was expected")

cockroachdb/cockroachdb_test.go

@@ -144,7 +144,7 @@ func TestNil(t *testing.T) {
 				t.Error("An error was expected")
 			}
 
-			var i interface{} // actually nil
+			var i any // actually nil
 			_, err = client.Get("foo", i)
 			if err == nil {
 				t.Error("An error was expected")

consul/consul.go

@@ -17,7 +17,7 @@ type Client struct {
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.
-func (c Client) Set(k string, v interface{}) error {
+func (c Client) Set(k string, v any) error {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return err
 	}
@@ -49,7 +49,7 @@ func (c Client) Set(k string, v interface{}) error {
 // that v points to with the values of the retrieved object's values.
 // If no value is found it returns (false, nil).
 // The key must not be "" and the pointer must not be nil.
-func (c Client) Get(k string, v interface{}) (found bool, err error) {
+func (c Client) Get(k string, v any) (found bool, err error) {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return false, err
 	}

consul/consul_test.go

@@ -140,7 +140,7 @@ func TestNil(t *testing.T) {
 				t.Error("An error was expected")
 			}
 
-			var i interface{} // actually nil
+			var i any // actually nil
 			_, err = client.Get("foo", i)
 			if err == nil {
 				t.Error("An error was expected")

datastore/datastore.go

@@ -34,7 +34,7 @@ type Client struct {
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.
-func (c Client) Set(k string, v interface{}) error {
+func (c Client) Set(k string, v any) error {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return err
 	}
@@ -65,7 +65,7 @@ func (c Client) Set(k string, v interface{}) error {
 // that v points to with the values of the retrieved object's values.
 // If no value is found it returns (false, nil).
 // The key must not be "" and the pointer must not be nil.
-func (c Client) Get(k string, v interface{}) (found bool, err error) {
+func (c Client) Get(k string, v any) (found bool, err error) {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return false, err
 	}

datastore/datastore_test.go

@@ -151,7 +151,7 @@ func TestNil(t *testing.T) {
 				t.Error("An error was expected")
 			}
 
-			var i interface{} // actually nil
+			var i any // actually nil
 			_, err = client.Get("foo", i)
 			if err == nil {
 				t.Error("An error was expected")

dynamodb/dynamodb.go

@@ -31,7 +31,7 @@ type Client struct {
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.
-func (c Client) Set(k string, v interface{}) error {
+func (c Client) Set(k string, v any) error {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return err
 	}
@@ -66,7 +66,7 @@ func (c Client) Set(k string, v interface{}) error {
 // that v points to with the values of the retrieved object's values.
 // If no value is found it returns (false, nil).
 // The key must not be "" and the pointer must not be nil.
-func (c Client) Get(k string, v interface{}) (found bool, err error) {
+func (c Client) Get(k string, v any) (found bool, err error) {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return false, err
 	}

dynamodb/dynamodb_test.go

@@ -180,7 +180,7 @@ func TestNil(t *testing.T) {
 				t.Error("An error was expected")
 			}
 
-			var i interface{} // actually nil
+			var i any // actually nil
 			_, err = client.Get("foo", i)
 			if err == nil {
 				t.Error("An error was expected")

encoding/codec.go

@@ -3,9 +3,9 @@ package encoding
 // Codec encodes/decodes Go values to/from slices of bytes.
 type Codec interface {
 	// Marshal encodes a Go value to a slice of bytes.
-	Marshal(v interface{}) ([]byte, error)
+	Marshal(v any) ([]byte, error)
 	// Unmarshal decodes a slice of bytes into a Go value.
-	Unmarshal(data []byte, v interface{}) error
+	Unmarshal(data []byte, v any) error
 }
 
 // Convenience variables

encoding/gob.go

@@ -10,7 +10,7 @@ import (
 type GobCodec struct{}
 
 // Marshal encodes a Go value to gob.
-func (c GobCodec) Marshal(v interface{}) ([]byte, error) {
+func (c GobCodec) Marshal(v any) ([]byte, error) {
 	buffer := new(bytes.Buffer)
 	encoder := gob.NewEncoder(buffer)
 	err := encoder.Encode(v)
@@ -21,7 +21,7 @@ func (c GobCodec) Marshal(v interface{}) ([]byte, error) {
 }
 
 // Unmarshal decodes a gob value into a Go value.
-func (c GobCodec) Unmarshal(data []byte, v interface{}) error {
+func (c GobCodec) Unmarshal(data []byte, v any) error {
 	reader := bytes.NewReader(data)
 	decoder := gob.NewDecoder(reader)
 	return decoder.Decode(v)

encoding/json.go

@@ -9,11 +9,11 @@ import (
 type JSONcodec struct{}
 
 // Marshal encodes a Go value to JSON.
-func (c JSONcodec) Marshal(v interface{}) ([]byte, error) {
+func (c JSONcodec) Marshal(v any) ([]byte, error) {
 	return json.Marshal(v)
 }
 
 // Unmarshal decodes a JSON value into a Go value.
-func (c JSONcodec) Unmarshal(data []byte, v interface{}) error {
+func (c JSONcodec) Unmarshal(data []byte, v any) error {
 	return json.Unmarshal(data, v)
 }

encoding/proto/proto.go

@@ -18,7 +18,7 @@ type PBcodec struct{}
 
 // Marshal encodes a proto message struct into the binary wire format.
 // Passed value can't be any Go value, but must be an object of a proto message struct.
-func (c PBcodec) Marshal(v interface{}) ([]byte, error) {
+func (c PBcodec) Marshal(v any) ([]byte, error) {
 	msg, ok := v.(proto.Message)
 	if !ok {
 		return nil, errors.New("error casting interface to proto")
@@ -28,7 +28,7 @@ func (c PBcodec) Marshal(v interface{}) ([]byte, error) {
 
 // Unmarshal parses a wire-format message in proto message struct.
 // Passed value can't be any Go value, but must be an object of a proto message struct.
-func (c PBcodec) Unmarshal(data []byte, v interface{}) error {
+func (c PBcodec) Unmarshal(data []byte, v any) error {
 	msg, ok := v.(proto.Message)
 	if !ok {
 		return errors.New("error casting interface to proto")

etcd/etcd.go

@@ -23,7 +23,7 @@ type Client struct {
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.
-func (c Client) Set(k string, v interface{}) error {
+func (c Client) Set(k string, v any) error {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return err
 	}
@@ -50,7 +50,7 @@ func (c Client) Set(k string, v interface{}) error {
 // that v points to with the values of the retrieved object's values.
 // If no value is found it returns (false, nil).
 // The key must not be "" and the pointer must not be nil.
-func (c Client) Get(k string, v interface{}) (found bool, err error) {
+func (c Client) Get(k string, v any) (found bool, err error) {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return false, err
 	}

etcd/etcd_test.go

@@ -6,7 +6,7 @@ import (
 	"testing"
 	"time"
 
-	"go.etcd.io/etcd/client/v3"
+	clientv3 "go.etcd.io/etcd/client/v3"
 
 	"github.com/philippgille/gokv/encoding"
 	"github.com/philippgille/gokv/etcd"
@@ -147,7 +147,7 @@ func TestNil(t *testing.T) {
 				t.Error("An error was expected")
 			}
 
-			var i interface{} // actually nil
+			var i any // actually nil
 			_, err = client.Get("foo", i)
 			if err == nil {
 				t.Error("An error was expected")

file/file.go

@@ -28,7 +28,7 @@ type Store struct {
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.
-func (s Store) Set(k string, v interface{}) error {
+func (s Store) Set(k string, v any) error {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return err
 	}
@@ -61,7 +61,7 @@ func (s Store) Set(k string, v interface{}) error {
 // that v points to with the values of the retrieved object's values.
 // If no value is found it returns (false, nil).
 // The key must not be "" and the pointer must not be nil.
-func (s Store) Get(k string, v interface{}) (found bool, err error) {
+func (s Store) Get(k string, v any) (found bool, err error) {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return false, err
 	}

file/file_test.go

@@ -117,7 +117,7 @@ func TestNil(t *testing.T) {
 				t.Error("An error was expected")
 			}
 
-			var i interface{} // actually nil
+			var i any // actually nil
 			_, err = store.Get("foo", i)
 			if err == nil {
 				t.Error("An error was expected")

freecache/freecache.go

@@ -18,7 +18,7 @@ type Store struct {
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.
-func (s Store) Set(k string, v interface{}) error {
+func (s Store) Set(k string, v any) error {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return err
 	}
@@ -37,7 +37,7 @@ func (s Store) Set(k string, v interface{}) error {
 // that v points to with the values of the retrieved object's values.
 // If no value is found it returns (false, nil).
 // The key must not be "" and the pointer must not be nil.
-func (s Store) Get(k string, v interface{}) (found bool, err error) {
+func (s Store) Get(k string, v any) (found bool, err error) {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return false, err
 	}

freecache/freecache_test.go

@@ -102,7 +102,7 @@ func TestNil(t *testing.T) {
 				t.Error("An error was expected")
 			}
 
-			var i interface{} // actually nil
+			var i any // actually nil
 			_, err = store.Get("foo", i)
 			if err == nil {
 				t.Error("An error was expected")

gomap/gomap.go

@@ -17,7 +17,7 @@ type Store struct {
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.
-func (s Store) Set(k string, v interface{}) error {
+func (s Store) Set(k string, v any) error {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return err
 	}
@@ -39,7 +39,7 @@ func (s Store) Set(k string, v interface{}) error {
 // that v points to with the values of the retrieved object's values.
 // If no value is found it returns (false, nil).
 // The key must not be "" and the pointer must not be nil.
-func (s Store) Get(k string, v interface{}) (found bool, err error) {
+func (s Store) Get(k string, v any) (found bool, err error) {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return false, err
 	}

gomap/gomap_test.go

@@ -104,7 +104,7 @@ func TestNil(t *testing.T) {
 				t.Error("An error was expected")
 			}
 
-			var i interface{} // actually nil
+			var i any // actually nil
 			_, err = store.Get("foo", i)
 			if err == nil {
 				t.Error("An error was expected")

hazelcast/hazelcast.go

@@ -22,7 +22,7 @@ type Client struct {
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.
-func (c Client) Set(k string, v interface{}) error {
+func (c Client) Set(k string, v any) error {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return err
 	}
@@ -47,7 +47,7 @@ func (c Client) Set(k string, v interface{}) error {
 // that v points to with the values of the retrieved object's values.
 // If no value is found it returns (false, nil).
 // The key must not be "" and the pointer must not be nil.
-func (c Client) Get(k string, v interface{}) (found bool, err error) {
+func (c Client) Get(k string, v any) (found bool, err error) {
 	if err := util.CheckKeyAndValue(k, v); err != nil {
 		return false, err
 	}