README
¶
Dump
This is an print debug vars util package.
- Github: https://github.com/gookit/goutil/dump
- GoDoc: https://pkg.go.dev/github.com/gookit/goutil/dump
Install
go get github.com/gookit/goutil/dump
Usage
run demo: go run ./dump/_examples/demo1.go
package main
import "github.com/gookit/goutil/dump"
// rum demo: go run ./dump/_examples/demo1.go
func main() {
otherFunc1()
}
func otherFunc1() {
dump.P(
23,
[]string{"ab", "cd"},
[]int{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11}, // len > 10
map[string]interface{}{
"key": "val", "sub": map[string]string{"k": "v"},
},
struct {
ab string
Cd int
}{
"ab", 23,
},
)
}
You will see:
More preview
- nested struct
Functions
func P(vs ...interface{})
func V(vs ...interface{})
func Print(vs ...interface{})
Related
- https://github.com/kr/pretty
- https://github.com/davecgh/go-spew More detail for kr/pretty
- https://github.com/kortschak/utter It's forks
Documentation
¶
Overview ¶
Package dump like fmt.Println but more pretty and beautiful print Go values.
Index ¶
- Constants
- func Config(fn func(opts *Options))
- func Fprint(w io.Writer, vs ...interface{})
- func P(vs ...interface{})
- func Print(vs ...interface{})
- func Println(vs ...interface{})
- func Reset()
- func V(vs ...interface{})
- type Dumper
- func (d *Dumper) Dump(vs ...interface{})
- func (d *Dumper) Fprint(w io.Writer, vs ...interface{})
- func (d *Dumper) Print(vs ...interface{})
- func (d *Dumper) Println(vs ...interface{})
- func (d *Dumper) ResetOptions()
- func (d *Dumper) WithOptions(fn func(opts *Options)) *Dumper
- func (d *Dumper) WithSkip(skip int) *Dumper
- func (d *Dumper) WithoutColor() *Dumper
- type Options
- type Theme
Examples ¶
Constants ¶
View Source
const ( Fnopos = 1 << iota // no position Ffunc Ffile Ffname Fline )
These flags define which print caller information
Variables ¶
This section is empty.
Functions ¶
func Print ¶
func Print(vs ...interface{})
Print like fmt.Println, but the output is clearer and more beautiful
Example ¶
Config(func(d *Options) {
d.NoColor = true
})
defer Reset()
Print(
23,
[]string{"ab", "cd"},
[]int{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11},
map[string]string{"key": "val"},
map[string]interface{}{
"sub": map[string]string{"k": "v"},
},
struct {
ab string
Cd int
}{
"ab", 23,
},
)
// Output like:
// PRINT AT github.com/gookit/goutil/dump.ExamplePrint(LINE 14):
// int(23)
// []string{"ab", "cd"}
// []int [
// 1,
// 2,
// 3,
// 4,
// 5,
// 6,
// 7,
// 8,
// 9,
// 10,
// 11,
// ]
// map[string]string {
// key: "val",
// }
// map[string]interface {} {
// sub: map[string]string{"k":"v"},
// }
// struct { ab string; Cd int } {
// ab: "ab",
// Cd: 23,
// }
//
Types ¶
type Dumper ¶ added in v0.3.0
type Dumper struct {
*Options
// contains filtered or unexported fields
}
Dumper struct definition
func (*Dumper) Print ¶ added in v0.3.0
func (d *Dumper) Print(vs ...interface{})
Print vars. alias of Dump()
func (*Dumper) Println ¶ added in v0.3.0
func (d *Dumper) Println(vs ...interface{})
Println vars. alias of Dump()
func (*Dumper) ResetOptions ¶ added in v0.3.0
func (d *Dumper) ResetOptions()
ResetOptions for dumper
func (*Dumper) WithOptions ¶ added in v0.3.0
WithOptions for dumper
func (*Dumper) WithoutColor ¶ added in v0.3.10
WithoutColor for dumper
type Options ¶ added in v0.3.0
type Options struct {
// Output output writer
Output io.Writer
// dont show type TODO
NoType bool
// dont with color
NoColor bool
// IndentLen width. default is 2
IndentLen int
// IndentChar default is one space
IndentChar byte
// MaxDepth for nested print
MaxDepth int
// ShowFlag for display caller position
ShowFlag int
// MoreLenNL array/slice elements length > MoreLenNL, will wrap new line
// MoreLenNL int
// CallerSkip skip for call runtime.Caller()
CallerSkip int
// ColorTheme for print result.
ColorTheme Theme
}
Options for dump vars
Source Files
Click to show internal directories.
Click to hide internal directories.