Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Copiers = 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.
Copy is unable to copy unexported fields in a struct (lowercase field names). Unexported fields can't be reflected by the Go runtime and therefore copystructure can't perform any data copies.
For structs, copy behavior can be controlled with struct tags. For example:
struct {
Name string
Data *bytes.Buffer `copy:"shallow"`
}
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.
Types ¶
type Config ¶
type Config struct {
// Lock any types that are a sync.Locker and are not a mutex while copying.
// If there is an RLocker method, use that to get the sync.Locker.
Lock bool
// Copiers is a map of types associated with a CopierFunc. Use the global
// Copiers map if this is nil.
Copiers map[reflect.Type]CopierFunc
}
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.
Source Files