marshal

Documentation

Index

• func DisableColors()
• func Marshall(format FormatType, items ...interface{}) ([]byte, error)
• type FormatType
• type Marshal
  • func NewMarshal(format FormatType) (*Marshal, error)
  • func (m *Marshal) Flush() error
  • func (m *Marshal) Write(writer io.Writer, item interface{}) error
• type Marshaller

Functions

func DisableColors

func DisableColors()

DisableColors disabled colors rendering in color function.

func Marshall

func Marshall(format FormatType, items ...interface{}) ([]byte, error)

Marshall marshals list of items.

Types

type FormatType

type FormatType int

FormatType describes output format type.

const (
	Plain FormatType = iota
	JSON
	NDJSON
	Trace
)

type Marshal

type Marshal struct {
	// contains filtered or unexported fields
}

Marshal implements the Marshaller interface. It wraps other marshaller based on argument passed to the NewMarshal method.

func NewMarshal

func NewMarshal(format FormatType) (*Marshal, error)

NewMarshal returns new Marshal instance.

func (*Marshal) Flush

func (m *Marshal) Flush() error

Flush implements the Marshaller interface.

func (*Marshal) Write

func (m *Marshal) Write(writer io.Writer, item interface{}) error

Write implements the Marshaller interface.

type Marshaller

type Marshaller interface {
	Write(writer io.Writer, item interface{}) error
	Flush() error
}

Marshaller is the interface which must be implemented by different marshallers used to format output for the CLI.