Init

example/scan-struct/README.md

@@ -0,0 +1,11 @@
+# Example for scanning hash fields into a struct
+
+To run this example:
+
+```shell
+go run .
+```
+
+See
+[Redis: Scanning hash fields into a struct](https://redis.uptrace.dev/guide/scanning-hash-fields.html)
+for details.

example/scan-struct/go.mod

@@ -0,0 +1,15 @@
+module github.com/redis/go-redis/example/scan-struct
+
+go 1.18
+
+replace github.com/redis/go-redis/v9 => ../..
+
+require (
+	github.com/davecgh/go-spew v1.1.1
+	github.com/redis/go-redis/v9 v9.5.3
+)
+
+require (
+	github.com/cespare/xxhash/v2 v2.2.0 // indirect
+	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
+)

example/scan-struct/go.sum

@@ -0,0 +1,8 @@
+github.com/bsm/ginkgo/v2 v2.12.0 h1:Ny8MWAHyOepLGlLKYmXG4IEkioBysk6GpaRTLC8zwWs=
+github.com/bsm/gomega v1.27.10 h1:yeMWxP2pV2fG3FgAODIY8EiRE3dy0aeFYt4l7wh6yKA=
+github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44=
+github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78=
+github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc=

example/scan-struct/main.go

@@ -0,0 +1,77 @@
+package main
+
+import (
+	"context"
+
+	"github.com/davecgh/go-spew/spew"
+
+	"github.com/redis/go-redis/v9"
+)
+
+type Model struct {
+	Str1    string   `redis:"str1"`
+	Str2    string   `redis:"str2"`
+	Bytes   []byte   `redis:"bytes"`
+	Int     int      `redis:"int"`
+	Bool    bool     `redis:"bool"`
+	Ignored struct{} `redis:"-"`
+}
+
+func main() {
+	ctx := context.Background()
+
+	rdb := redis.NewClient(&redis.Options{
+		Addr: ":6379",
+	})
+	_ = rdb.FlushDB(ctx).Err()
+
+	// Set some fields.
+	if _, err := rdb.Pipelined(ctx, func(rdb redis.Pipeliner) error {
+		rdb.HSet(ctx, "key", "str1", "hello")
+		rdb.HSet(ctx, "key", "str2", "world")
+		rdb.HSet(ctx, "key", "int", 123)
+		rdb.HSet(ctx, "key", "bool", 1)
+		rdb.HSet(ctx, "key", "bytes", []byte("this is bytes !"))
+		return nil
+	}); err != nil {
+		panic(err)
+	}
+
+	var model1, model2 Model
+
+	// Scan all fields into the model.
+	if err := rdb.HGetAll(ctx, "key").Scan(&model1); err != nil {
+		panic(err)
+	}
+
+	// Or scan a subset of the fields.
+	if err := rdb.HMGet(ctx, "key", "str1", "int").Scan(&model2); err != nil {
+		panic(err)
+	}
+
+	spew.Dump(model1)
+	// Output:
+	// (main.Model) {
+	// 	Str1: (string) (len=5) "hello",
+	// 	Str2: (string) (len=5) "world",
+	// 	Bytes: ([]uint8) (len=15 cap=16) {
+	// 	 00000000  74 68 69 73 20 69 73 20  62 79 74 65 73 20 21     |this is bytes !|
+	// 	},
+	// 	Int: (int) 123,
+	// 	Bool: (bool) true,
+	// 	Ignored: (struct {}) {
+	// 	}
+	// }
+
+	spew.Dump(model2)
+	// Output:
+	// (main.Model) {
+	// 	Str1: (string) (len=5) "hello",
+	// 	Str2: (string) "",
+	// 	Bytes: ([]uint8) <nil>,
+	// 	Int: (int) 123,
+	// 	Bool: (bool) false,
+	// 	Ignored: (struct {}) {
+	// 	}
+	// }
+}