jsonstream

Documentation

Overview

Package jsonstream implements streaming reader and writer for JSON objects.

Index

• type Reader
  • func NewReader(r io.Reader, header string, summary interface{}) (*Reader, error)
  • func (r *Reader) Read(v interface{}) error
• type Writer
  • func NewWriter(w io.Writer, header string) *Writer
  • func (w *Writer) Finalize() error
  • func (w *Writer) FinalizeWithSummary(summary interface{}) error
  • func (w *Writer) Write(v interface{}) error

Types

type Reader

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

Reader reads a stream of JSON objects.

func NewReader

func NewReader(r io.Reader, header string, summary interface{}) (*Reader, error)

NewReader returns new Reader on top of a given buffered reader. The provided header must match the beginning of a stream.

func (*Reader) Read

func (r *Reader) Read(v interface{}) error

Read reads the next JSON objects from the stream, returns io.EOF on the end of stream.

type Writer

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

Writer writes a stream of JSON objects.

func NewWriter

func NewWriter(w io.Writer, header string) *Writer

NewWriter creates a new Writer on top of a specified writer with a specified optional header.

func (*Writer) Finalize

func (w *Writer) Finalize() error

Finalize writes the postamble to the JSON stream.

func (*Writer) FinalizeWithSummary

func (w *Writer) FinalizeWithSummary(summary interface{}) error

FinalizeWithSummary writes the postamble to the JSON stream with a given summary object.

func (*Writer) Write

func (w *Writer) Write(v interface{}) error

Write JSON object to the output.