README
¶
XGo/dump
Quick Look
aInt := 1
bStr := `sf`
cMap := map[string]interface{}{"name": "z", "age": 14}
dArray := []interface{}{&cMap, aInt, bStr}
dump.Dump(aInt, &aInt, &bStr, bStr, cMap, dArray, cMap["name"], dArray[2], dArray[aInt])
Option
custom options
// disable dump in global, default false means enable
// disable it in production to ignore the unnecessary output and risks
dump.Disable = false
// show variant line in head
dump.ShowFileLine1 = true
// change writer in global
dump.DefaultWriter = os.Stdout
// only show the first-n elements
// others will show as '...'
// * these options is design for debug clearly
dump.MaxSliceLen = 32
dump.MaxMapLen = 32
// serialize options
// render map with sorted keys
dump.OptSortMapKeys = true
// render []uint8(`ab`) as string("ab")
OptShowUint8sAsString = true
// render uint8(97) as char('a')
OptShowUint8AsChar
More TestCases
https://github.com/Kretech/xgo/blob/master/dump/dumper_test.go
https://github.com/Kretech/xgo/blob/master/dump/serialize_test.go
Documentation
¶
Index ¶
Examples ¶
Constants ¶
View Source
const ( Zero = `<zero>` Nil = "<nil>" )
Variables ¶
View Source
var ( // uint8(97) => 'a' OptShowUint8AsChar = true // []uint8{'a','b'} => "ab" OptShowUint8sAsString = true // 按字典序显示map.keys OptSortMapKeys = true )
View Source
var ( MaxSliceLen = 32 MaxMapLen = 32 SepKv = " => " StringQuota = `"` )
View Source
var Disable = false
disable dump in global scope use it in production
Functions ¶
func Dump ¶
func Dump(args ...interface{})
Example ¶
package main
import (
"os"
"github.com/Kretech/xgo/dump"
)
func main() {
// just for testing
dump.ShowFileLine1 = false
dump.DefaultWriter = os.Stdout
a := 1
b := `2`
c := map[string]interface{}{b: a}
dump.Dump(a, b, c)
}
Output: a => 1 b => "2" c => map[string]interface{} (len=1) { "2" => 1 }
Types ¶
type CliDumper ¶
type CliDumper struct {
// contains filtered or unexported fields
}
func NewCliDumper ¶
Example ¶
package main
import (
"os"
)
func main() {
a := 1
b := `2`
ShowFileLine1 = false
DefaultWriter = os.Stdout
g1 := NewCliDumper(`g1`)
g1.Dump(a, b)
g2 := MyPackage{MyDump: MyDump}
g2.MyDump(a, b)
}
// MyPackage mock the package name. so we can called it by `x.y()`
type MyPackage struct {
MyDump func(...interface{})
}
func MyDump(args ...interface{}) {
_g := NewCliDumper(`g2`) // means package name
_g.DepthDump(1, args...)
}
Output: a => 1 b => "2" a => 1 b => "2"
Source Files
Click to show internal directories.
Click to hide internal directories.