From d6675c7152e69606543295ef704405ebad6a95cb Mon Sep 17 00:00:00 2001
From: Mitchell Hashimoto <mitchell.hashimoto@gmail.com>
Date: Tue, 2 Feb 2021 12:02:29 -0800
Subject: [PATCH] add support for "ignore" tag

---
 copystructure.go      | 12 +++++++++++-
 copystructure_test.go | 20 ++++++++++++++++++++
 2 files changed, 31 insertions(+), 1 deletion(-)

diff --git a/copystructure.go b/copystructure.go
index b6e1c39..efa52ae 100644
--- a/copystructure.go
+++ b/copystructure.go
@@ -25,6 +25,9 @@ const tagKey = "copy"
 //
 // The available tag values are:
 //
+// * "ignore" - The field will be ignored, effectively resulting in it being
+//   assigned the zero value in the copy.
+//
 // * "shallow" - The field will be be shallow copied. This means that references
 //   values such as pointers, maps, slices, etc. will be directly assigned
 //   versus deep copied.
@@ -421,12 +424,19 @@ func (w *walker) StructField(f reflect.StructField, v reflect.Value) error {
 	w.valPush(reflect.ValueOf(f))
 
 	// If we're shallow copying then push the value as-is onto the stack.
-	if tv := f.Tag.Get(tagKey); tv == "shallow" {
+	switch f.Tag.Get(tagKey) {
+	case "shallow":
 		w.valPush(v)
 
 		// set ignore depth one level deeper so we don't ignore the value
 		// we put on the stack but we do ignore diving into it.
 		w.ignoreDepth = w.depth + 1
+
+	case "ignore":
+		// Do nothing, we have to pop off our structfield so we undo any
+		// prior work in this func
+		w.valPop()
+		return reflectwalk.SkipEntry
 	}
 
 	return nil
diff --git a/copystructure_test.go b/copystructure_test.go
index 15b22ee..461c8e4 100644
--- a/copystructure_test.go
+++ b/copystructure_test.go
@@ -245,6 +245,26 @@ func TestCopy_structShallow(t *testing.T) {
 	}
 }
 
+func TestCopy_structIgnore(t *testing.T) {
+	type test struct {
+		Value  string
+		Value2 *string `copy:"ignore"`
+	}
+
+	value2 := "bar"
+	value2ptr := &value2
+	v := test{Value: "foo", Value2: value2ptr}
+
+	result, err := Copy(v)
+	if err != nil {
+		t.Fatalf("err: %s", err)
+	}
+	vcopy := result.(test)
+	if vcopy.Value2 != nil {
+		t.Fatal("should be nil")
+	}
+}
+
 func TestCopy_structNested(t *testing.T) {
 	type TestInner struct{}