Documentation ¶
Overview ¶
Package clone provides functions to deep clone any Go data. It also provides a wrapper to protect a pointer from any unexpected mutation.
Index ¶
- func Clone(v interface{}) interface{}
- func IsScalar(k reflect.Kind) bool
- func MarkAsOpaquePointer(t reflect.Type)
- func MarkAsScalar(t reflect.Type)
- func SetCustomFunc(t reflect.Type, fn Func)
- func Slowly(v interface{}) interface{}
- func Undo(v interface{})
- func Unwrap(v interface{}) interface{}
- func Wrap(v interface{}) interface{}
- type Allocator
- func (a *Allocator) Clone(val reflect.Value) reflect.Value
- func (a *Allocator) CloneSlowly(val reflect.Value) reflect.Value
- func (a *Allocator) MakeChan(t reflect.Type, buffer int) reflect.Value
- func (a *Allocator) MakeMap(t reflect.Type, n int) reflect.Value
- func (a *Allocator) MakeSlice(t reflect.Type, len, cap int) reflect.Value
- func (a *Allocator) MarkAsOpaquePointer(t reflect.Type)
- func (a *Allocator) MarkAsScalar(t reflect.Type)
- func (a *Allocator) New(t reflect.Type) reflect.Value
- func (a *Allocator) SetCustomFunc(t reflect.Type, fn Func)
- type AllocatorMethods
- type Cloner
- type Func
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Clone ¶
func Clone(v interface{}) interface{}
Clone recursively deep clone v to a new value in heap. It assumes that there is no pointer cycle in v, e.g. v has a pointer points to v itself. If there is a pointer cycle, use Slowly instead.
Clone allocates memory and deeply copies values inside v in depth-first sequence. There are a few special rules for following types.
- Scalar types: all number-like types are copied by value.
- func: Copied by value as func is an opaque pointer at runtime.
- string: Copied by value as string is immutable by design.
- unsafe.Pointer: Copied by value as we don't know what's in it.
- chan: A new empty chan is created as we cannot read data inside the old chan.
Unlike many other packages, Clone is able to clone unexported fields of any struct. Use this feature wisely.
func IsScalar ¶
IsScalar returns true if k should be considered as a scalar type.
For the sake of performance, string is considered as a scalar type unless arena is enabled. If we need to deep copy string value in some cases, we can create a new allocator with custom isScalar function in which we can return false when k is reflect.String.
// Create a new allocator which treats string as non-scalar type. allocator := NewAllocator(nil, &AllocatorMethods{ IsScalar: func(k reflect.Kind) bool { return k != reflect.String && IsScalar(k) }, })
func MarkAsOpaquePointer ¶
MarkAsOpaquePointer marks t as an opaque pointer in heap allocator, so that all clone methods will copy t by value. If t is not a pointer, MarkAsOpaquePointer ignores t.
Here is a list of types marked as opaque pointers by default:
- `elliptic.Curve`, which is `*elliptic.CurveParam` or `elliptic.p256Curve`;
- `reflect.Type`, which is `*reflect.rtype` defined in `runtime`.
Example ¶
type OpaquePointerType struct { foo int } MarkAsOpaquePointer(reflect.TypeOf(new(OpaquePointerType))) opaque := &OpaquePointerType{ foo: 123, } cloned := Clone(opaque).(*OpaquePointerType) // cloned is a shadow copy of opaque. // so that opaque and cloned should be the same. fmt.Println(opaque == cloned)
Output: true
func MarkAsScalar ¶
MarkAsScalar marks t as a scalar type in heap allocator, so that all clone methods will copy t by value. If t is not struct or pointer to struct, MarkAsScalar ignores t.
In the most cases, it's not necessary to call it explicitly. If a struct type contains scalar type fields only, the struct will be marked as scalar automatically.
Here is a list of types marked as scalar by default:
- time.Time
- reflect.Value
Example ¶
type ScalarType struct { stderr *os.File } MarkAsScalar(reflect.TypeOf(new(ScalarType))) scalar := &ScalarType{ stderr: os.Stderr, } cloned := Clone(scalar).(*ScalarType) // cloned is a shadow copy of scalar // so that the pointer value should be the same. fmt.Println(scalar.stderr == cloned.stderr)
Output: true
func SetCustomFunc ¶
SetCustomFunc sets a custom clone function for type t in heap allocator. If t is not struct or pointer to struct, SetCustomFunc ignores t.
If fn is nil, remove the custom clone function for type t.
Example ¶
type MyStruct struct { Data []interface{} } // Filter nil values in Data when cloning old value. SetCustomFunc(reflect.TypeOf(MyStruct{}), func(allocator *Allocator, old, new reflect.Value) { // The new is a zero value of MyStruct. // We can get its address to update it. value := new.Addr().Interface().(*MyStruct) // The old is guaranteed to be a MyStruct. // As old.CanAddr() may be false, we'd better to read Data field directly. data := old.FieldByName("Data") l := data.Len() for i := 0; i < l; i++ { val := data.Index(i) if val.IsNil() { continue } n := allocator.Clone(val).Interface() value.Data = append(value.Data, n) } }) slice := &MyStruct{ Data: []interface{}{ "abc", nil, 123, nil, }, } cloned := Clone(slice).(*MyStruct) fmt.Println(cloned.Data)
Output: [abc 123]
Example (PartiallyClone) ¶
type T struct { Value int } type MyStruct struct { S1 *T S2 string S3 int } SetCustomFunc(reflect.TypeOf(T{}), func(allocator *Allocator, old, new reflect.Value) { oldField := old.FieldByName("Value") newField := new.FieldByName("Value") newField.SetInt(oldField.Int() + 100) }) SetCustomFunc(reflect.TypeOf(MyStruct{}), func(allocator *Allocator, old, new reflect.Value) { // We can call allocator.Clone to clone the old value without worrying about dead loop. // This custom func is temporary disabled for the old value in allocator. new.Set(allocator.Clone(old)) oldField := old.FieldByName("S2") newField := new.FieldByName("S2") newField.SetString(oldField.String() + "_suffix") }) st := &MyStruct{ S1: &T{ Value: 1, }, S2: "abc", S3: 2, } cloned := Clone(st).(*MyStruct) data, _ := json.Marshal(st) fmt.Println(string(data)) data, _ = json.Marshal(cloned) fmt.Println(string(data))
Output: {"S1":{"Value":1},"S2":"abc","S3":2} {"S1":{"Value":101},"S2":"abc_suffix","S3":2}
func Slowly ¶
func Slowly(v interface{}) interface{}
Slowly recursively deep clone v to a new value in heap. It marks all cloned values internally, thus it can clone v with cycle pointer.
Slowly works exactly the same as Clone. See Clone doc for more details.
Example ¶
type ListNode struct { Data int Next *ListNode } node1 := &ListNode{ Data: 1, } node2 := &ListNode{ Data: 2, } node3 := &ListNode{ Data: 3, } node1.Next = node2 node2.Next = node3 node3.Next = node1 // We must use `Slowly` to clone a circular linked list. node := Slowly(node1).(*ListNode) for i := 0; i < 10; i++ { fmt.Println(node.Data) node = node.Next }
Output: 1 2 3 1 2 3 1 2 3 1
func Undo ¶
func Undo(v interface{})
Undo discards any change made in wrapped value. If v is not a wrapped value, nothing happens.
func Unwrap ¶
func Unwrap(v interface{}) interface{}
Unwrap returns v's original value if v is a wrapped value. Otherwise, simply returns v itself.
func Wrap ¶
func Wrap(v interface{}) interface{}
Wrap creates a wrapper of v, which must be a pointer. If v is not a pointer, Wrap simply returns v and do nothing.
The wrapper is a deep clone of v's value. It holds a shadow copy to v internally.
t := &T{Foo: 123} v := Wrap(t).(*T) // v is a clone of t. reflect.DeepEqual(t, v) == true // v equals t. v.Foo = 456 // v.Foo is changed, but t.Foo doesn't change. orig := Unwrap(v) // Use `Unwrap` to discard wrapper and return original value, which is t. orig.(*T) == t // orig and t is exactly the same. Undo(v) // Use `Undo` to discard any change on v. v.Foo == t.Foo // Now, the value of v and t are the same again.
Example ¶
// Suppose we have a type T defined as following. // type T struct { // Foo int // } v := &T{ Foo: 123, } w := Wrap(v).(*T) // Wrap value to protect it. // Use w freely. The type of w is the same as that of v. // It's OK to modify w. The change will not affect v. w.Foo = 456 fmt.Println(w.Foo) // 456 fmt.Println(v.Foo) // 123 // Once we need the original value stored in w, call `Unwrap`. orig := Unwrap(w).(*T) fmt.Println(orig == v) // true fmt.Println(orig.Foo) // 123 // Or, we can simply undo any change made in w. // Note that `Undo` is significantly slower than `Unwrap`, thus // the latter is always preferred. Undo(w) fmt.Println(w.Foo) // 123
Output: 456 123 true 123 123
Types ¶
type Allocator ¶
type Allocator struct {
// contains filtered or unexported fields
}
Allocator is a utility type for memory allocation.
Example ¶
// We can create a new allocator to hold customized config without poluting the default allocator. // Calling FromHeap() is a convenient way to create a new allocator which allocates memory from heap. allocator := FromHeap() // Mark T as scalar only in the allocator. type T struct { Value *int } allocator.MarkAsScalar(reflect.TypeOf(new(T))) t := &T{ Value: new(int), } cloned1 := allocator.Clone(reflect.ValueOf(t)).Interface().(*T) cloned2 := Clone(t).(*T) fmt.Println(t.Value == cloned1.Value) fmt.Println(t.Value == cloned2.Value)
Output: true false
Example (DeepCloneString) ¶
// By default, string is considered as scalar and copied by value. // In some cases, we may need to clone string deeply, that is, copy the underlying bytes. // We can use a custom allocator to do this. allocator := NewAllocator(nil, &AllocatorMethods{ IsScalar: func(t reflect.Kind) bool { return t != reflect.String && IsScalar(t) }, }) cloner := MakeCloner(allocator) data := []byte("bytes") s1 := *(*string)(unsafe.Pointer(&data)) // Unsafe conversion from []byte to string. s2 := Clone(s1).(string) // s2 shares the same underlying bytes with s1. s3 := cloner.Clone(s1).(string) // s3 has its own underlying bytes. copy(data, "magic") // Change the underlying bytes. fmt.Println(s1) fmt.Println(s2) fmt.Println(s3)
Output: magic magic bytes
Example (SyncPool) ¶
type Foo struct { Bar int } typeOfFoo := reflect.TypeOf(Foo{}) poolUsed := 0 // For test only. // A sync pool to allocate Foo. p := &sync.Pool{ New: func() interface{} { return &Foo{} }, } // Creates a custom allocator using p as pool. allocator := NewAllocator(unsafe.Pointer(p), &AllocatorMethods{ New: func(pool unsafe.Pointer, t reflect.Type) reflect.Value { // If t is Foo, allocate value from the sync pool p. if t == typeOfFoo { poolUsed++ // For test only. p := (*sync.Pool)(pool) v := p.Get() runtime.SetFinalizer(v, func(v *Foo) { *v = Foo{} p.Put(v) }) return reflect.ValueOf(v) } // Fallback to reflect API. return reflect.New(t) }, }) // Do clone. target := []*Foo{ {Bar: 1}, {Bar: 2}, } cloned := allocator.Clone(reflect.ValueOf(target)).Interface().([]*Foo) fmt.Println(reflect.DeepEqual(target, cloned)) fmt.Println(poolUsed)
Output: true 2
func FromHeap ¶
func FromHeap() *Allocator
FromHeap creates an allocator which allocate memory from heap.
func NewAllocator ¶
func NewAllocator(pool unsafe.Pointer, methods *AllocatorMethods) (allocator *Allocator)
NewAllocator creates an allocator which allocate memory from the pool. Both pool and methods are optional.
If methods.New is not nil, the allocator itself is created by calling methods.New.
The pool is a pointer to the memory pool which is opaque to the allocator. It's methods's responsibility to allocate memory from the pool properly.
func (*Allocator) Clone ¶
Clone recursively deep clone val to a new value with memory allocated from a.
func (*Allocator) CloneSlowly ¶
CloneSlowly recursively deep clone val to a new value with memory allocated from a. It marks all cloned values internally, thus it can clone v with cycle pointer.
func (*Allocator) MakeSlice ¶
MakeSlice creates a new zero-initialized slice value of t with len and cap.
func (*Allocator) MarkAsOpaquePointer ¶
MarkAsOpaquePointer marks t as an opaque pointer so that all clone methods will copy t by value. If t is not a pointer, MarkAsOpaquePointer ignores t.
Here is a list of types marked as opaque pointers by default:
- `elliptic.Curve`, which is `*elliptic.CurveParam` or `elliptic.p256Curve`;
- `reflect.Type`, which is `*reflect.rtype` defined in `runtime`.
func (*Allocator) MarkAsScalar ¶
MarkAsScalar marks t as a scalar type so that all clone methods will copy t by value. If t is not struct or pointer to struct, MarkAsScalar ignores t.
In the most cases, it's not necessary to call it explicitly. If a struct type contains scalar type fields only, the struct will be marked as scalar automatically.
Here is a list of types marked as scalar by default:
- time.Time
- reflect.Value
type AllocatorMethods ¶
type AllocatorMethods struct { // Parent is the allocator which handles all unhandled methods. // If it's nil, it will be the default allocator. Parent *Allocator New func(pool unsafe.Pointer, t reflect.Type) reflect.Value MakeSlice func(pool unsafe.Pointer, t reflect.Type, len, cap int) reflect.Value MakeMap func(pool unsafe.Pointer, t reflect.Type, n int) reflect.Value MakeChan func(pool unsafe.Pointer, t reflect.Type, buffer int) reflect.Value IsScalar func(k reflect.Kind) bool }
AllocatorMethods defines all methods required by allocator. If any of these methods is nil, allocator will use default method which allocates memory from heap.
type Cloner ¶
type Cloner struct {
// contains filtered or unexported fields
}
Cloner implements clone API with given allocator.
func MakeCloner ¶
MakeCloner creates a cloner with given allocator.
func (Cloner) Clone ¶
func (c Cloner) Clone(v interface{}) interface{}
Clone clones v with given allocator.
func (Cloner) CloneSlowly ¶
func (c Cloner) CloneSlowly(v interface{}) interface{}
CloneSlowly clones v with given allocator. It can clone v with cycle pointer.