copystructure

README

copystructure

copystructure is a Go library for deep copying values in Go.

This allows you to copy Go values that may contain reference values such as maps, slices, or pointers, and copy their data as well instead of just their references.

Installation

Standard go get:

$ go get github.com/mitchellh/copystructure

Usage & Example

For usage and examples see the Godoc.

The Copy function has examples associated with it there.

Documentation

Index

• Variables
• func Copy(v interface{}) (interface{}, error)
• type CopierFunc

Examples

• Copy

Variables

var Copiers map[reflect.Type]CopierFunc = make(map[reflect.Type]CopierFunc)

Copiers is a map of types that behave specially when they are copied. If a type is found in this map while deep copying, this function will be called to copy it instead of attempting to copy all fields.

The key should be the type, obtained using: reflect.TypeOf(value with type).

It is unsafe to write to this map after Copies have started. If you are writing to this map while also copying, wrap all modifications to this map as well as to Copy in a mutex.

Functions

func Copy

func Copy(v interface{}) (interface{}, error)

Copy returns a deep copy of v.

Example

input := map[string]interface{}{
	"bob": map[string]interface{}{
		"emails": []string{"a", "b"},
	},
}

dup, err := Copy(input)
if err != nil {
	panic(err)
}

fmt.Printf("%#v", dup)

Output:

map[string]interface {}{"bob":map[string]interface {}{"emails":[]string{"a", "b"}}}

Types

type CopierFunc

type CopierFunc func(interface{}) (interface{}, error)

CopierFunc is a function that knows how to deep copy a specific type. Register these globally with the Copiers variable.