package litter

import "github.com/sanity-io/litter"

Index ¶

• Variables
• func Dump(value ...interface{})
• func MapReusedPointers(v reflect.Value) []uintptr
• func Sdump(value ...interface{}) string
• type Dumper
• type Options
• func (o Options) Dump(values ...interface{})
• func (o Options) Sdump(values ...interface{}) string

Variables ¶

var Config = Options{
	StripPackageNames: false,
	HidePrivateFields: true,
	FieldExclusions:   regexp.MustCompile(`^(XXX_.*)$`),
	Separator:         " ",
}

Config is the default config used when calling Dump

Functions ¶

func Dump ¶

func Dump(value ...interface{})

Dump a value to stdout

func MapReusedPointers ¶

func MapReusedPointers(v reflect.Value) []uintptr

MapReusedPointers : Given a structure, it will recurively map all pointers mentioned in the tree, breaking circular references and provide a list of all pointers that was referenced at least twice by the provided structure.

func Sdump ¶

func Sdump(value ...interface{}) string

Sdump dumps a value to a string

Types ¶

type Dumper ¶

type Dumper interface {
	LitterDump(w io.Writer)
}

Dumper is the interface for implementing custom dumper for your types.

type Options ¶

type Options struct {
	Compact           bool
	StripPackageNames bool
	HidePrivateFields bool
	HideZeroValues    bool
	FieldExclusions   *regexp.Regexp
	FieldFilter       func(reflect.StructField, reflect.Value) bool
	HomePackage       string
	Separator         string
}

Options represents configuration options for litter

func (Options) Dump ¶

func (o Options) Dump(values ...interface{})

Dump a value to stdout according to the options

func (Options) Sdump ¶

func (o Options) Sdump(values ...interface{}) string

Sdump dumps a value to a string according to the options

Source Files ¶

dump.go mapper.go print.go util.go