pp

Documentation

Index

• Constants
• Variables
• func Errorf(format string, a ...interface{}) error
• func Fatal(a ...interface{})
• func Fatalf(format string, a ...interface{})
• func Fatalln(a ...interface{})
• func Fprint(w io.Writer, a ...interface{}) (n int, err error)
• func Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error)
• func Fprintln(w io.Writer, a ...interface{}) (n int, err error)
• func GetDefaultOutput() io.Writer
• func Print(a ...interface{}) (n int, err error)
• func Printf(format string, a ...interface{}) (n int, err error)
• func Println(a ...interface{}) (n int, err error)
• func ResetColorScheme()
• func ResetDefaultOutput()
• func SetColorScheme(scheme ColorScheme)
• func SetDefaultOutput(o io.Writer)
• func Sprint(a ...interface{}) string
• func Sprintf(format string, a ...interface{}) string
• func Sprintln(a ...interface{}) string
• type ColorScheme

Constants

const (
	Black uint16
	Red
	Green
	Yellow
	Blue
	Magenta
	Cyan
	White
)

const (
	BackgroundBlack uint16
	BackgroundRed
	BackgroundGreen
	BackgroundYellow
	BackgroundBlue
	BackgroundMagenta
	BackgroundCyan
	BackgroundWhite
)

const (
	// Bold flag for ColorScheme.
	Bold uint16 = 1<<bitsBold | NoColor
)

const (
	// No color
	NoColor uint16 = 1 << 15
)

Variables

var (
	// If the length of array or slice is larger than this,
	// the buffer will be shorten as {...}.
	BufferFoldThreshold = 1024
)

var (
	// If you set false to this variable, you can use pretty formatter
	// without coloring.
	ColoringEnabled = true
)

var (

	// WithLineInfo add file name and line information to output
	// call this function with care, because getting stack has performance penalty
	WithLineInfo = false
)

Functions

func Errorf

func Errorf(format string, a ...interface{}) error

Errorf formats given arguments and returns it as error type.

func Fatal

func Fatal(a ...interface{})

Fatal prints given arguments and finishes execution with exit status 1.

func Fatalf

func Fatalf(format string, a ...interface{})

Fatalf prints a given format and finishes execution with exit status 1.

func Fatalln

func Fatalln(a ...interface{})

Fatalln prints given arguments with newline and finishes execution with exit status 1.

func Fprint

func Fprint(w io.Writer, a ...interface{}) (n int, err error)

Fprint prints given arguments to a given writer.

func Fprintf

func Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error)

Fprintf prints format to a given writer.

func Fprintln

func Fprintln(w io.Writer, a ...interface{}) (n int, err error)

Fprintln prints given arguments to a given writer with newline.

func GetDefaultOutput

func GetDefaultOutput() io.Writer

GetDefaultOutput returns pp's default output.

func Print

func Print(a ...interface{}) (n int, err error)

Print prints given arguments.

func Printf

func Printf(format string, a ...interface{}) (n int, err error)

Printf prints a given format.

func Println

func Println(a ...interface{}) (n int, err error)

Println prints given arguments with newline.

func ResetColorScheme

func ResetColorScheme()

ResetColorScheme resets colorscheme to default.

func ResetDefaultOutput

func ResetDefaultOutput()

Change Print* functions' output to default one.

func SetColorScheme

func SetColorScheme(scheme ColorScheme)

SetColorScheme takes a colorscheme used by all future Print calls.

func SetDefaultOutput

func SetDefaultOutput(o io.Writer)

Change Print* functions' output to a given writer. For example, you can limit output by ENV.

func init() {
	if os.Getenv("DEBUG") == "" {
		pp.SetDefaultOutput(ioutil.Discard)
	}
}

func Sprint

func Sprint(a ...interface{}) string

Sprint formats given arguemnts and returns the result as string.

func Sprintf

func Sprintf(format string, a ...interface{}) string

Sprintf formats with pretty print and returns the result as string.

func Sprintln

func Sprintln(a ...interface{}) string

Sprintln formats given arguemnts with newline and returns the result as string.

Types

type ColorScheme

type ColorScheme struct {
	Bool            uint16
	Integer         uint16
	Float           uint16
	String          uint16
	StringQuotation uint16
	EscapedChar     uint16
	FieldName       uint16
	PointerAdress   uint16
	Nil             uint16
	Time            uint16
	StructName      uint16
	ObjectLength    uint16
}

To use with SetColorScheme.