# README
dump
Package dump can dump a Go data structure to Go source file, so that it can be statically embeded into other code.
Project Status
- UnsafePointer is not supported yet
- Cycles in the object graph are not supported yet
Implementation Notes
Aliasing
Aliases to primitives and structs will be preserved in the objects described by the generated code.
Primitive pointers
var a = "hello world"
var Obj = &struct {
Foo *string
Bar *string
}{
Foo: &a,
Bar: &a,
}
dump.dump(Obj)
will output
var p1Var = "hello world"
var p1 = &p1Var
var Obj = &struct { Foo *string; Bar *string }{
Foo: p1,
Bar: p1,
}
Reused pointers
type Zeo struct {
A *string
}
var z = Zeo {
A: "hello world",
}
var Obj = &struct {
Foo *Zeo
Bar *Zeo
}{
Foo: &z,
Bar: &z,
}
dump.dump(Obj)
will output
var p1 = &Zeo{
A: "hello world",
}
var Obj = &struct { Foo *Zeo; Bar *Zeo }{
Foo: p1,
Bar: p1,
}
# Functions
Dump a value to stdout.
GetPointers recursively maps all pointers mentioned in a tree, breaking circular references, and provides a list of: * all pointers * all pointers that were referenced at least twice * all pointers that point to primitive type.
Sdump dumps a value to a string.
# Variables
Config is the default config used when calling Dump.