package dump

Import Path
	github.com/gookit/goutil/dump (on go.dev)

Dependency Relation
	imports 13 packages, and imported by one package

Involved Source Files

	  d dump.go
		Package dump like fmt.Println but more pretty and beautiful print Go values.

	    dumper.go
	    options.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type Dumper (struct)
		Dumper struct definition

		Fields (total 15)
			Options *Options
			Options.BytesAsString bool
				BytesAsString dump handle.

			Options.CallerSkip int
				CallerSkip skip for call runtime.Caller()

			Options.ColorTheme Theme
				ColorTheme for print result.

			Options.IndentChar byte
				IndentChar default is one space

			Options.IndentLen int
				IndentLen width. default is 2

			Options.MaxDepth int
				MaxDepth for nested print

			Options.MaxElementsNum int
				MoreLenNL array/slice elements length > MoreLenNL, will wrap new line
				MoreLenNL int
				MaxElementsNum for a long-long slice or array. The excess will be displayed `...`

			Options.NoColor bool
				NoColor don't with color

			Options.NoType bool
				NoType don't show data type TODO

			Options.Output io.Writer
				Output the output writer

			Options.ShowFlag int
				ShowFlag for display caller position

			Options.ShowLen bool
				ShowLen display length information for string, slice, array, map

			Options.SkipNilField bool
				SkipNilField value dump on map, struct.

			Options.SkipPrivate bool
				SkipPrivate field dump on struct.

		Methods (total 8)
			(*Dumper) Dump(vs ...any)
				Dump vars

			(*Dumper) Fprint(w io.Writer, vs ...any)
				Fprint print vars to io.Writer

			(*Dumper) Print(vs ...any)
				Print vars. alias of Dump()

			(*Dumper) Println(vs ...any)
				Println vars. alias of Dump()

			(*Dumper) ResetOptions()
				ResetOptions for dumper

			(*Dumper) WithOptions(fns ...OptionFunc) *Dumper
				WithOptions for dumper

			(*Dumper) WithSkip(skip int) *Dumper
				WithSkip for dumper

			(*Dumper) WithoutColor() *Dumper
				WithoutColor for dumper

		Implements (at least one exported)
			*Dumper : github.com/go-sql-driver/mysql.Logger
		As Outputs Of (at least 7)
			func NewDumper(out io.Writer, skip int) *Dumper
			func NewWithOptions(fns ...OptionFunc) *Dumper
			func Std() *Dumper
			func Std2() *Dumper
			func (*Dumper).WithOptions(fns ...OptionFunc) *Dumper
			func (*Dumper).WithoutColor() *Dumper
			func (*Dumper).WithSkip(skip int) *Dumper

	 type OptionFunc (func)
		OptionFunc type

		As Outputs Of (at least 9)
			func BytesAsString() OptionFunc
			func SkipNilField() OptionFunc
			func SkipPrivate() OptionFunc
			func WithCallerSkip(skip int) OptionFunc
			func WithoutColor() OptionFunc
			func WithoutLen() OptionFunc
			func WithoutOutput(out io.Writer) OptionFunc
			func WithoutPosition() OptionFunc
			func WithoutType() OptionFunc
		As Inputs Of (at least 3)
			func Config(fns ...OptionFunc)
			func NewWithOptions(fns ...OptionFunc) *Dumper
			func (*Dumper).WithOptions(fns ...OptionFunc) *Dumper

	 type Options (struct)
		Options for dumper

		Fields (total 14)
			BytesAsString bool
				BytesAsString dump handle.

			CallerSkip int
				CallerSkip skip for call runtime.Caller()

			ColorTheme Theme
				ColorTheme for print result.

			IndentChar byte
				IndentChar default is one space

			IndentLen int
				IndentLen width. default is 2

			MaxDepth int
				MaxDepth for nested print

			MaxElementsNum int
				MoreLenNL array/slice elements length > MoreLenNL, will wrap new line
				MoreLenNL int
				MaxElementsNum for a long-long slice or array. The excess will be displayed `...`

			NoColor bool
				NoColor don't with color

			NoType bool
				NoType don't show data type TODO

			Output io.Writer
				Output the output writer

			ShowFlag int
				ShowFlag for display caller position

			ShowLen bool
				ShowLen display length information for string, slice, array, map

			SkipNilField bool
				SkipNilField value dump on map, struct.

			SkipPrivate bool
				SkipPrivate field dump on struct.

		As Outputs Of (at least one exported)
			func NewDefaultOptions(out io.Writer, skip int) *Options

	 type Theme (map)
		Theme color code/tag map for dump


Package-Level Functions (total 25)

	 func BytesAsString() OptionFunc
		BytesAsString setting.

	 func Clear(vs ...any)
		Clear dump clear data, without location.

	 func Config(fns ...OptionFunc)
		Config std dumper

	 func Format(vs ...any) string
		Format like fmt.Println, but the output is clearer and more beautiful

	 func Fprint(w io.Writer, vs ...any)
		Fprint like fmt.Println, but the output is clearer and more beautiful

	 func NewDefaultOptions(out io.Writer, skip int) *Options
		NewDefaultOptions create.

	 func NewDumper(out io.Writer, skip int) *Dumper
		NewDumper create

	 func NewWithOptions(fns ...OptionFunc) *Dumper
		NewWithOptions create

	 func NoLoc(vs ...any)
		NoLoc dump vars data, without location.

	 func P(vs ...any)
		P like fmt.Println, but the output is clearer and more beautiful

	 func Print(vs ...any)
		Print like fmt.Println, but the output is clearer and more beautiful

	 func Println(vs ...any)
		Println like fmt.Println, but the output is clearer and more beautiful

	 func Reset()
		Reset std dumper

	 func Reset2()
		Reset2 reset std2 dumper

	 func SkipNilField() OptionFunc
		SkipNilField setting.

	 func SkipPrivate() OptionFunc
		SkipPrivate field dump on struct.

	 func Std() *Dumper
		Std dumper

	 func Std2() *Dumper
		Std2 dumper

	 func V(vs ...any)
		V like fmt.Println, but the output is clearer and more beautiful

	 func WithCallerSkip(skip int) OptionFunc
		WithCallerSkip on print caller position information.

	 func WithoutColor() OptionFunc
		WithoutColor setting.

	 func WithoutLen() OptionFunc
		WithoutLen setting. hide length information for string, slice, array, map.

	 func WithoutOutput(out io.Writer) OptionFunc
		WithoutOutput setting.

	 func WithoutPosition() OptionFunc
		WithoutPosition dont print call dump position information.

	 func WithoutType() OptionFunc
		WithoutType setting.


Package-Level Constants (total 5)

	const Ffile = 4
		These flags define which print caller information

	const Ffname = 8
		These flags define which print caller information

	const Ffunc = 2
		These flags define which print caller information

	const Fline = 16
		These flags define which print caller information

	const Fnopos = 1 // no position
		These flags define which print caller information

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.