jsonlines

Documentation

Overview

Package json lines mimicks standard library json Encoder and Decoder, but to encode and decode one JSON per line.

Index

• Constants
• type Decoder
  • func NewDecoder(r io.Reader) Decoder
• type Encoder
  • func NewEncoder(w io.Writer) Encoder

Constants

const (
	// DefaultBufferSize is the default buffer size for decoding. It will
	// be used whenever the given reader is not buffered.
	DefaultBufferSize = 1024 * 1024 * 4
)

Types

type Decoder

type Decoder interface {
	// Decode decodes the next JSON line into the given value.
	Decode(interface{}) error
}

Decoder decodes JSON lines.

func NewDecoder

func NewDecoder(r io.Reader) Decoder

NewDecoder creates a new decoder with the given reader. If the given reader is not buffered, it will be wrapped with a *bufio.Reader.

type Encoder

type Encoder interface {
	// Encode encodes the next value into a JSON line.
	Encode(interface{}) error
}

Encoder encodes JSON lines.

func NewEncoder

func NewEncoder(w io.Writer) Encoder

NewEncoder creates a new encoder using the given writer.